Apiggs和postman配合使用

Apiggs - 非侵入的RestDoc文档生成工具

使用方法

• 在pom里<plugins>里复制粘贴下面

<!--api文档-->
            <plugin>
                <groupId>com.github.apiggs</groupId>
                <artifactId>apiggs-maven-plugin</artifactId>
                <version>1.6</version>
                <executions>
                    <execution>
                        <phase>compile</phase>
                        <goals>
                            <goal>apiggs</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>

• idea里找到右侧maven视图，Plugins->apiggs->双击即可
• 会发现在target\apiggs下生成xxx.html(可双击食用)和xxx.json(可导入postman直接使用)

注意

• 在代码书写中有关中文注释用，跟着第二行中间只留中文(不要有其他修饰词,比如@Description)

/**
 * 接待信息表 前端控制器
 * @author haoyunsheng@inspur.com
 * @since 2020-07-07
 */
 
 /**
     * 你好
     * @Author haoyunsheng@inspur.com
     * @Date 2020/7/8 9:53
     * @Param []
     * @return java.lang.String
     **/
    @GetMapping(value = "/hello")

• 注释里不要出现<>,否则会出错： 注释@return里比如List<Map> 出现<会报错(原因未知)，写成如下图就行

/**
     * 获取年度预算、决算；接待批次、人数
     *
     * @return
     * @Author haoyunsheng@inspur.com
     * @Date 2020/7/9 10:52
     * @Param
     **/

产出成果展示

postman.json使用

• 导入
• 创新新的环境变量：host指定ip
• 成果