• swagger api 文档框架


    <其他教程:https://www.cnblogs.com/FlyAway2013/p/7510279.html>

    先看看swagger的生态使用图:

    这里写图片描述
    其中,红颜色的是swaggger官网方推荐的。

    下面再细看看swagger的生态的具体内容:

    swagger-ui

    这玩意儿从名字就能看出来,用来显示API文档的。和rap不同的是,它不可以编辑。

    这里写图片描述

    点击某个详细API的可以试。

    这里写图片描述

    swagger-editor

    就是一个在线编辑文档说明文件(swagger.json或swagger.yaml文件)的工具,以方便生态中的其他小工具(swagger-ui)等使用。 
    左边编辑,右边立马就显示出编辑内容来。 
    这里写图片描述

    编辑swagger说明文件使用的是yaml语法具体的内容可以去官网查看。

    各种语言版本的根据annotation或者注释生成swagger说明文档的工具

    目前最流行的做法,就是在代码注释中写上swagger相关的注释,然后,利用小工具生成swagger.json或者swagger.yaml文件。

    目前官方没有推出。github上各种语言各种框架各种有,可以自己搜吧搜吧,这里只说一个php相关的。 
    swagger-php :https://github.com/zircote/swagger-php

    swagger-validator

    这个小工具是用来校验生成的文档说明文件是否符合语法规定的。用法非常简单,只需url地址栏,根路径下加上一个参数url,参数内容是放swagger说明文件的地址。即可校验。 
    例如: 
    这里写图片描述
    docker hub地址为:https://hub.docker.com/r/swaggerapi/swagger-validator/ 
    可以pull下镜像来自己玩玩。

    swagger-codegen

    代码生成器,脚手架。可以根据swagger.json或者swagger.yml文件生成指定的计算机语言指定框架的代码。 
    有一定用处,Java系用的挺多。工业上应该不咋用。

  • 相关阅读:
    day01--计算机硬件基础笔记
    22 Jun 18 Django,ORM
    21 Jun 18 Django,ORM
    20 Jun 18 复习, mysql
    20 Jun 18 Django,ORM
    19 Jun 18 复习, 正则表达式
    19 Jun 18 Django
    15 Jun 18 复习, shutil模块
    15 Jun 18 Django
    14 Jun 18 复习, form表单
  • 原文地址:https://www.cnblogs.com/SH-xuliang/p/9068135.html
Copyright © 2020-2023  润新知