用户工具

站点工具


tools:swagger

swagger增强版

knife4j,使用knife4j-front即可。

nginx配置(doc子域名)

需要配置调试时请求的service服务地址。

server {
        server_name doc.xlongwei.com;
        index doc.html;
        root /soft/knife4j-front;
        location /service/ {
                proxy_pass http://api;
        }
}

nginx配置(api站点子目录)

修改doc.html倒数第7行内容:url:“/json/group.json”,修改为url:“json/group.json”(启动时加载子目录内的json/group.json),调试时直接请求已配置好的service地址。

server {
	server_name api.xlongwei.com;
	location / {
		proxy_pass http://127.0.0.1:8080;
	}
	location /swagger/json/ {
		alias H:/works/itecheast/light4j/knife4j/;
	}
	location /swagger/ {
		alias D:/OpenSource/xiaoym/knife4j.git/knife4j-front/;
	}
	location = /swagger { return 301 /swagger/; }
}

swagger文档地址

swagger/doc.html,可以和原版swagger对比一下效果。

接口文档md转word和pdf

  1. 文档管理=》离线文档,拷贝文档(markdown格式)
  2. md在线编辑,下载markdown、html、word、pdf
  3. 安装word插件writage,安装即可
  4. 使用word打开下载的markdown文件,另存为word即可(带导航窗格)
  5. 另存为pdf,点击选项,勾选:创建书签时使用,标题

swagger注解

  • Api,ApiOperation:对应Controller和方法,接口分组,values简介notes详解简书
  • ApiImplicitParams,ApiImplicitParam:name参数values简介dataType类名或基本类型String等,paramType有path query body header form
  • ApiResponses,ApiResponse:message消息,response全类名,responseContainer仅限List Set Map
  • ApiModel,ApiModelProperty:value描述example示例
tools/swagger.txt · 最后更改: 2021/02/28 22:52 由 admin