自动化文档系统：微服务下的 API 管理利器

<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.4.0</version>
</dependency>
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.4.0</version>
</dependency>

@Configuration
@EnableSwagger2
public class SwaggerConfiguration {

    @Bean
    public Docket buildDocket(){
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(buildApiInf())
                .select()
                .apis(RequestHandlerSelectors.basePackage("demo.tke.sc.bookinfo.service"))
                .paths(PathSelectors.any())
                .build();
    }

    private ApiInfo buildApiInf(){
        return new ApiInfoBuilder()
                .title("Bookinfo Service APIs")
                .description("图书服务的 API 文档，本页面采用 swagger 自动生成，可以查看图书服务对外提供的所有 API 及其对应的方法和参数说明，同时提供了在线测试功能。关于 swagger 的详细功能，请访问其官网：https://swagger.io")
                .termsOfServiceUrl("https://cloud.tencent.com")
                .contact(new Contact("森林木", "https://cloud.tencent.com", "yuanlinbao@tencent.com"))
                .build();

    }
}

@Api(description="Admin APIs",tags={"图书管理接口"})
@RestController
@RequestMapping("/admin")
public class AdminController {

    @ApiOperation("添加图书")
    @PostMapping(value = "/addBook")
    public @ResponseBody
    Response<String> addBook(@ApiParam(name="bookInfoDto",value="Json 格式的图书信息",required=true) @RequestBody BookInfoDto bookInfoDto) {

        Response<String> resp = new Response<String>();
        resp.setCode(200);
        resp.setMsg("【添加图书】" + bookInfoDto.getTitle() + " 成功！");

        return resp;
    }

    @ApiOperation("删除图书")
    @DeleteMapping(value = "/removeBook/{isbn}")
    public @ResponseBody Response<String> removeteBook(@ApiParam(name="isbn",value="国际标准书号ISBN，长整型",required=true) @PathVariable Long isbn) {
        Response<String> resp = new Response<String>();
        resp.setCode(200);
        resp.setMsg("【删除图书】 ISBN " + isbn  + " 成功！");
        return resp;
    }

    @ApiOperation("修改图书信息")
    @PostMapping(value = "/modifyBookInfo")
    public @ResponseBody Response<String> modifyBookInfo(@ApiParam(name="bookInfoDto",value="Json 格式的图书信息",required=true) @RequestBody BookInfoDto bookInfoDto) {

        Response<String> resp = new Response<String>();
        resp.setCode(200);
        resp.setMsg("【修改图书】" + bookInfoDto.getTitle() + " 成功！");

        return resp;
    }
}

@Api(tags={"用户接口"}, description = "User APIs")
@RestController
@RequestMapping("/bookinfo")
public class UserController {

    @ApiOperation("查询图书信息")
    @GetMapping(value = "/{isbn}")
    public @ResponseBody
    Response<BookInfoDto> getBookInfo(@ApiParam(name="isbn",value="国际标准书号ISBN，长整型",required=true) @PathVariable Long isbn) {
    
        BookInfoDto bookInfo = new BookInfoDto();
        bookInfo.setIsbn(isbn);
        bookInfo.setTitle("Dubbo Mesh");
        bookInfo.setAuthor("jack");
        bookInfo.setPrice(100.00f);

        return new Response<BookInfoDto>(200, bookInfo);
    }

    @ApiOperation("图书列表")
    @PostMapping(value = "/bookList")
    public @ResponseBody Response<List<BookInfoDto>> listBook() {

        BookInfoDto bookInfo1 = new BookInfoDto();
        bookInfo1.setIsbn(9787111653240L);
        bookInfo1.setTitle("云原生：运用容器、函数计算和数据构建下一代应用");
        bookInfo1.setAuthor("[美] Boris，Scholl，[美] Trent，Swanson 著，季奔牛 译");
        bookInfo1.setPrice(75.1f);

        BookInfoDto bookInfo2 = new BookInfoDto();
        bookInfo2.setIsbn(9787111644682L);
        bookInfo2.setTitle("Istio服务网格技术解析与实践");
        bookInfo2.setAuthor("王夕宁");
        bookInfo2.setPrice(94.1f);

        List<BookInfoDto> bookInfos = new ArrayList<BookInfoDto>(2);
        bookInfos.add(bookInfo1);
        bookInfos.add(bookInfo2);

        return new Response<List<BookInfoDto>>(200, bookInfos);
    }
}

@Data // 不想写 get set 方法的话，保留此注解同时添加 lomok 依赖
@ApiModel(description="图书信息类" )
public class BookInfoDto {

    @ApiModelProperty(value = "国际标准书号 ISBN ", required = true)
    private Long isbn;

    @ApiModelProperty(value = "书名", required = true)
    private String title;

    @ApiModelProperty(value = "作者", required = true)
    private String author;

    @ApiModelProperty(value = "价格", required=false)
    private Float price;
}

# 执行以下命令，下载 Node.js Linux 64位二进制安装包。
wget https://nodejs.org/dist/v10.16.3/node-v10.16.3-linux-x64.tar.xz

# 执行以下命令，解压安装包。
tar xvf node-v10.16.3-linux-x64.tar.xz

# 依次执行以下命令，创建软链接。
ln -s /root/node-v10.16.3-linux-x64/bin/node /usr/local/bin/node
ln -s /root/node-v10.16.3-linux-x64/bin/npm /usr/local/bin/npm

# 依次执行以下命令，查看 Node.js 及 npm 版本信息。
node -v
npm -v

# 执行以下命令，安装 git。
yum install -y git

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors
cp vendors/config_example.json ./config.json  # 复制完成后请修改相关配置
cd vendors
npm install --production --registry https://registry.npm.taobao.org
# 安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
npm run install-server 
# 启动服务
node server/app.js