RESTful Web Service¶

package com.sample.todo.api.todo;

import jp.co.intra_mart.foundation.web_api_maker.annotation.ProvideFactory;
import jp.co.intra_mart.foundation.web_api_maker.annotation.ProvideService;
import jp.co.intra_mart.foundation.web_api_maker.annotation.WebAPIMaker;
import jp.co.intra_mart.framework.extension.spring.context.ApplicationContextProvider;

@WebAPIMaker
public class TodoServiceFactory {

    @ProvideFactory
    public static TodoServiceFactory getFactory() {
        return new TodoServiceFactory();
    }

    @ProvideService
    public TodoApiService getService() {
        return ApplicationContextProvider.getApplicationContext().getBean(TodoApiService.class);
    }
}

package com.sample.todo.api.todo;

import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import jp.co.intra_mart.foundation.web_api_maker.annotation.BasicAuthentication;
import jp.co.intra_mart.foundation.web_api_maker.annotation.Body;
import jp.co.intra_mart.foundation.web_api_maker.annotation.DELETE;
import jp.co.intra_mart.foundation.web_api_maker.annotation.GET;
import jp.co.intra_mart.foundation.web_api_maker.annotation.POST;
import jp.co.intra_mart.foundation.web_api_maker.annotation.PUT;
import jp.co.intra_mart.foundation.web_api_maker.annotation.Path;
import jp.co.intra_mart.foundation.web_api_maker.annotation.Required;
import jp.co.intra_mart.foundation.web_api_maker.annotation.Response;
import jp.co.intra_mart.foundation.web_api_maker.annotation.Variable;
import com.sample.todo.api.NotFoundException;

@BasicAuthentication(pathPrefix = "")
@Todo
public interface TodoApiService {

    @GET(summary = "Todo情報を取得します。", description = "Todo情報の一覧を取得します。")
    @Path("/api/v1/todos")
    @TodoTag
    public List<TodoResource> getTodos();

    @POST(summary = "Todo情報を登録します。", description = "Todo情報を登録します。idは自動採番します。")
    @Path("/api/v1/todos")
    @Response(code = 201)
    @TodoTag
    public TodoResource postTodos(@Required @Body TodoResource todoResource, HttpServletRequest request, HttpServletResponse response);

    @GET(summary = "Todo情報を取得します。", description = "指定したTodo情報を取得します。指定したTodo情報が無い場合、404を返します。")
    @Path("/api/v1/todos/{todoId}")
    @TodoTag
    public TodoResource getTodo(@Required @Variable(name = "todoId") String todoId) throws NotFoundException;

    @PUT(summary = "Todoを完了します。", description = "Todo情報の完了フラグをONにします。")
    @Path("/api/v1/todos/{todoId}")
    @TodoTag
    public TodoResource putTodo(@Required @Variable(name = "todoId") String todoId);

    @DELETE(summary = "Todo情報を削除します。", description = "Todo情報を削除します。")
    @Path("/api/v1/todos/{todoId}")
    @Response(code = 204)
    @TodoTag
    public void deleteTodo(@Required @Variable(name = "todoId") String todoId);
}

package com.sample.todo.api.todo;

import java.net.URI;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;

import javax.inject.Inject;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.dozer.Mapper;
import org.springframework.stereotype.Component;
import org.springframework.web.servlet.support.ServletUriComponentsBuilder;
import org.terasoluna.gfw.common.exception.ResourceNotFoundException;

import com.sample.todo.api.NotFoundException;
import com.sample.todo.domain.model.Todo;
import com.sample.todo.domain.service.todo.TodoService;

@Component
public class TodoApiServiceImpl implements TodoApiService {

    @Inject
    TodoService todoService;

    @Inject
    Mapper mapper;

    @Override
    public List<TodoResource> getTodos() {
        Collection<Todo> todos = todoService.findAll();
        List<TodoResource> todoResources = new ArrayList<>();
        for (Todo todo : todos) {
            todoResources.add(mapper.map(todo, TodoResource.class));
        }
        return todoResources;
    }

    @Override
    public TodoResource postTodos(TodoResource todoResource, HttpServletRequest request, HttpServletResponse response) {
        Todo createdTodo = todoService.create(mapper.map(todoResource, Todo.class));
        TodoResource createdTodoResponse = mapper.map(createdTodo, TodoResource.class);
        ServletUriComponentsBuilder uriBuilder = ServletUriComponentsBuilder.fromRequest(request);
        URI uri = uriBuilder.pathSegment(createdTodoResponse.getTodoId()).build().toUri();
        response.addHeader("Location", uri.toASCIIString());
        return createdTodoResponse;
    }

    @Override
    public TodoResource getTodo(String todoId) throws NotFoundException {
        try {
            Todo todo = todoService.findOne(todoId);
            TodoResource todoResource = mapper.map(todo, TodoResource.class);
            return todoResource;
        } catch (ResourceNotFoundException e) {
            throw new NotFoundException(e.getMessage());
        }
    }

    @Override
    public TodoResource putTodo(String todoId) {
        Todo finishedTodo = todoService.finish(todoId);
        TodoResource finishedTodoResource = mapper.map(finishedTodo, TodoResource.class);
        return finishedTodoResource;
    }

    @Override
    public void deleteTodo(String todoId) {
        todoService.delete(todoId);
    }
}

package com.sample.todo.api;

import jp.co.intra_mart.foundation.web_api_maker.annotation.Response;

@Response(code = 404)
public class NotFoundException extends Exception {

    private static final long serialVersionUID = 1L;

    public NotFoundException() {
        super();
    }

    public NotFoundException(String message, Throwable cause, boolean enableSuppression, boolean writableStackTrace) {
        super(message, cause, enableSuppression, writableStackTrace);
    }

    public NotFoundException(String message, Throwable cause) {
        super(message, cause);
    }

    public NotFoundException(String message) {
        super(message);
    }

    public NotFoundException(Throwable cause) {
        super(cause);
    }
}