Java高级教程之SpringCloud-18：SpringCloud Swagger注解方式的API文档

下面使用注解方式生成订单微服务的API文档中心。首先在pom.xml中加入swagger的依赖。

 

https://github.com/swagger-api/swagger-core/wiki/Annotations

 

 

然后在ApplicationMain类加上注解@EnableSwagger2Doc，并且在application.yml配置文件里加入 swagger配置。

 

接下来在OrderController中加入swagger的注解，比如@Api描述Controller类，@ApiOperation表示类方法，@ApiImplicitParam表示方法的参数。

 

 

package com.lpplpp.app.controller;

import com.lpplpp.app.model.Order;
import com.lpplpp.app.service.OrderService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

@RestController
@Api("订单API")
public class OrderController {

    @Autowired
    private OrderService orderService;

    @GetMapping(value = "order/{id}")
    @ApiOperation("getById方法")
    @ApiImplicitParam(name="id", value="order id", paramType="Long", example="e.g. /order/1")
    public Order getById(@PathVariable("id") Long id) {
        return orderService.getById(id);
    }

}

 

 

重启订单服务，访问swagger-ui.html地址，查看API文档中心。

http://localhost:8180/swagger-ui.html#/order-controller