总结一下日常使用的swagger
这个东西可是java开发接口的利器,不仅可以根据文档生成可视化网页(swagger-ui),更可以生成相应的接口代码(swagger-codegen)
主要是三个文件起作用 上图
xxxx.yaml: 定义接口的swagger文档
当然根据需求对于swagger oneapi的定义有很多技巧,详细可以参见官网
https://swagger.io/docs/specification/about/
openapi: 3.0.0
info:
title: Sample API
description: Optional multiline or single-line description in [CommonMark](http://commonmark.org/help/) or HTML.
version: 0.1.9
servers:
- url: http://api.example.com/v1
description: Optional server description