Создание веб-службы REST с использованием Spring

Единственный сервис, предоставляемый нашим контроллером, — это метод pay () , который выглядит очень просто; он проверяет клиентский запрос, используя предопределенный общий ключ, обрабатывает запрос и возвращает статус операции.

Ниже приведены общие аннотации, используемые нашим контроллером:

• @RestController: эта аннотация помечает класс как ресурс, она неявно определяет аннотации @Controller и @ResponseBody MVC, при аннотировании класса с помощью @RestController нет необходимости писать @ResponseBody рядом с классами POJO, возвращаемыми из ваших методов.
• @RequestMapping: эта аннотация определяет URL ресурса в дополнение к типу метода: GET / POST, в нашем примере мы предоставляем платежный сервис как POST, доступ к которому осуществляется через / payment / pay.
• @RequestParam: эта аннотация представляет конкретный параметр запроса, в нашем примере мы сопоставляем параметр запроса с именем key с ключом аргумента типа String.
• @RequestBody:  эта аннотация представляет тело запроса, в нашем примере мы сопоставляем тело запроса с классом POJO типа PaymentRequest (Джексон обрабатывает преобразование JSON / POJO).

Как уже было отмечено, ответ представлен в виде BaseResponse, и нет необходимости аннотировать его, Джексон неявно преобразует его в JSON.

4. Настройте REST API

После реализации нашего ресурса и определения запросов и ответов нашего API, теперь нам нужно настроить контекстную ссылку нашего API и дать команду нашему контейнеру сервлетов загрузить ресурс при запуске. Без этого раздела конфигурации ваши ресурсы не будут доступны клиентам.

Spring 4.3.0 поддерживает несколько аннотаций конфигурации, больше нет необходимости определять конфигурации в web.xml .

По сути, нам нужно создать два класса:

• ApplicationInitializer: это класс инициализатора, который загружается при запуске приложения, он определяет класс конфигурации приложения вместе с URL-адресом контекста.
• ApplicationConfiguration: это класс конфигурации приложения, он в основном используется для указания контейнера сервлета загружать ресурсы REST из определенного пакета.

Вот так:

package com.programmer.gate;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

@Configuration
@EnableWebMvc
@ComponentScan(basePackages = "com.programmer.gate")
public class ApplicationConfiguration {


}

package com.programmer.gate;

import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;

public class ApplicationInitializer extends AbstractAnnotationConfigDispatcherServletInitializer {

 @Override
 protected Class < ? > [] getRootConfigClasses() {
  return new Class[] {
   ApplicationConfiguration.class
  };
 }

 @Override
 protected Class < ? > [] getServletConfigClasses() {
  return null;
 }

 @Override
 protected String[] getServletMappings() {
  return new String[] {
   "/rest/*"
  };
 }

}

{
 "status": "success",
 "code": 100
}

{
 "status": "error",
 "code": 102
}