认识Swagger

需要知道的似乎很多,需要说的似乎很少

Swagger是进行接口的定义、管理、测试的工具集。服务于前后端分离。
Swagger项目地址
核心是Swagger对于接口的定义规范——OpenAPI Specification——一个使用json或者yaml进行接口各种信息定义的规范。也就是我们创建一组json/yaml文件描述我们的接口。然后我们可以用这个接口——生成特定语言的接口实现代码,测试接口。可以看看规范的内容,挺多的。。。多的。。。的。。。

  1. swagger-editor,一个前端项目,编写json/yaml接口文件的,动态可视化。
    认识Swagger_第1张图片
  2. swagger-ui,是一个前端项目。读取json/yaml文件,解析并可视化。可以进行接口测试。上面那个地址就是我们定义的json文件地址。
    认识Swagger_第2张图片
  3. swagger-codegen,接口文件也是要来指导生产代码的。这个项目就是生成各种语言的接口代码。支持好多好多好多平台和语言了。没下载,没啥用过呢。想着用处不大。
  4. swagger-core,好像是java实现。没看。如果要实现上面的功能,有人喜欢就好。如果是实现最后说的随代码自动生成json文件的功能,应该依赖于各种业务框架来实现。单独实现没啥意义。

到这里应该完了。但是,写过代码的你,肯定感觉到了——项目开始迭代时,你改了代码,还要改接口文件。。。。
想着可以直接写代码,然后有个工具自动生成json文件。当然有了,不同语言,自己找找。

  1. java的spring框架,对此肯定不能等着了,spring-fox,使用spring的注解,标记处接口的各种信息。然后自动生成json(想当然耳,没看)。
这是网上搜的sprng-boot使用swagger的。怎么用当然自己找了。

    com.spring4all
    swagger-spring-boot-starter
    1.7.0.RELEASE

你可能感兴趣的:(认识Swagger)