编写文档

SOP采用微服务架构实现，因此文档应该由各个微服务各自实现。难点就是如何统一归纳各个微服务端提供的文档信息，并且统一展示。

写完接口后使用swagger注解来定义自己的文档信息。步骤如下：

• 在config中添加swagger配置

• 编写swagger注解
  分别在请求参数和返回结果类中编写@ApiModelProperty

其中value属性填接口名称，简明扼要。填写接口的详细信息，介绍，用途，注意事项等。

• 启动website-server(运行WebsiteServerApplication.java)
• 找到sop-website/website-front/pages/doc/doc.html，IDEA下右键—Debug
  如果没有IDEA可以下个webstorm，同样有本地静态服务器功能。

效果图如下

注解对应关系

swagger注解和文档界面显示关系如下图所示：