Swagger trong springboot

Bạn đã từng phát triển API restful webservice bằng Spring rồi sau đó lại phải viết tài liệu mô tả từng API với tham số param và mã lỗi trả về

Nếu bạn đã từng thì bài viết này sẽ rất hữu ích cho bạn với cách tiếp cận mới

Bạn chỉ việc phát triển API theo đúng chuẩn rồi sau đó enable Swagger trong hệ thống SpringBoot của bạn

Swagger sẽ tự động đọc code và xuất ra tài liệu mô tả API cho bạn, rồi bạn chỉ việc gửi đường dẫn Swagger cho Frontend-developer tham khảo

Phần cấu hình tôi sẽ hướng dẫn bạn sau. Rất đơn giản để thực hiện cấu hình Swagger trên SpringBoot

@WebService

@Api(value = "Emailssssssss")

@Path(value = "/v1.0/emails")

public class erviceImpl extends BaseWebService implements EmailService {

 

    private static Logger logger = LogManager.getLogger(xxxxxxxImpl.class);

 

    @POST

    @ApiOperation(value = "Send emailsss", response = EmailResponse.class)

    @Path("/emailsssssss")

    @Produces({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })

    @Consumes({ MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON })

    public Response sendEmailssss(@ApiParam(name="sendEmailssRequest", required=true) SendEmailsssssRequest request) {

     

        logger.info("[EmailService]: sendEmail - " + request.getTo() + " - " + request.getTitle());

         

        String attachments = Strings.EMPTY;

        SendEmailResponse<String> result;

 

        try {

         

                result = new SendEmailResponse<>(EmailService.SENDING_ERROR,

         

        } catch (Exception e) {

 

           

            result = new SendEmailsssResponse<>(EmailService.SENDING_ERROR,

                    EmailService.SENDING_ERROR, e.getMessage());

        }

 

        return Response.ok(result).header("Access-Control-Allow-Origin", "*").build();

    }