问题:
不同软件/程序在网络中互相传递信息不统一。
交互不便。 REST API
作用:
RESTful API就是一套协议,用来规范多种形式的前端和同一个后台的交互方式。
原理: 组成/流程/规范:
遵守OpenAPI规范 软件的REST API文档 问题:
在API的迭代开发过程中,文档更新工作容易遗漏。 swagger框架
功能:
生成遵守OpenAPI规范的、JSON或YAML格式的RESTful API文档。
实现:
读取嵌入到源代码中的api文档,生成api文档。 swagger规范:
作用:
编辑器 解析 yaml/json字符串
(使用此规范的) (遵守此规范的) 借助swagger-py-codegen框架
由 生成 web framework 的结构代码 由注解代码自动生成rest api文档。 应用层协议:DNS/FTP/SMTP/HTTP等等
REST和Http关系:
REST is just a set of rules about how to use HTTP
https://stackoverflow.com/questions/2190836/what-is-the-difference-between-http-and-rest RESTfull api生态: REST api描述规范:OpenAPI规范。
围绕OpenAPI规范构建的开源工具:Swagger。
https://www.breakyizhan.com/swagger/2806.html API文档管理工具:Swagger类似
https://www.cnblogs.com/softidea/p/5728952.html
https://hacpai.com/article/1519833837647
https://zhuanlan.zhihu.com/p/45591474 与tornado相关的swagger工具
https://github.com/rduldulao/tornado-swirl
(要求python3.6以上、tornado5.1.1以上)
https://github.com/SerenaFeng/tornado-swagger

REST api文档管理工具的更多相关文章

  1. API文档管理工具-数据库表结构思考.

    API文档管理工具-数据库表结构思考. PS: 管理工具只是为了方便自己记录API的一些基本信息,方便不同的开发人员 (App Developer, Restful API Developer)之间的 ...

  2. API文档管理工具

    系统庞大之后,前后端分离开发,前端调用后端提供的接口,请求协议一般是 HTTP,数据格式一般是 JSON.后台只负责数据的提供和计算,而完全不处理展现逻辑和样式:前端则负责拿到数据,组织数据并展现的工 ...

  3. 在线API文档管理工具Simple doc

    Simple doc是一个简易的文档发布管理工具,为什么要写Simple doc呢?主要原因还是github的wiki并不好用:没有目录结构,文章没有Hx标签索引,最悲剧的是文章编辑的时候不能直接图片 ...

  4. API 文档管理工具 (Yapi) Docker Compose部署指南

    前言介绍 Yapi 由 YMFE 开源,旨在为开发.产品.测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建.发布.维护 API. 权限管理 YApi 成熟的团队管理扁平化项目权限配置满足各类企 ...

  5. 一个能快速写出实体类的Api文档管理工具

    今天各种MVC框架满天飞,大大降低了编码的难度,写实体类就没有办法回避的一件事了,花大把的时间去做一些重复而且繁琐的工作,实在不是一个优秀程序员的作风,所以多次查找和尝试后,找到一个工具类网站——Ap ...

  6. 顶尖 API 文档管理工具 (Yapi)

    原文地址:https://www.jianshu.com/p/a97d2efb23c5

  7. api(接口)文档管理工具

    api(接口)文档管理工具 欢迎光临:博之阅API管理平台  ,做为一个app开发者,还没有用到api管理工具,你就OUT了 点击进入:程序员精华博客大全  

  8. showdoc 开源在线api&&技术文档管理工具

    showdoc 是一个很不错的api 以及技术文档管理工具 环境准备 doker-copose 文件 version: "3" services: doc: image: regi ...

  9. api接口测试工具和接口文档管理工具

    api接口测试工具和接口文档管理工具 1.postman(https://www.getpostman.com) Postman 是一个很强大的 API调试.Http请求的工具.她可是允许用户发送任何 ...

随机推荐

  1. PHP 解压 ZIP 文件到指定文件夹

    本类实现参考 php manual 评论 [php] view plain copy /** * function: 解压zip 格式的文件 * author:friker * date:2015-1 ...

  2. 回顾<Video Timing Controller v6.1>

    回顾<Video Timing Controller v6.1> VTC总体架构图: 对于最基本的功能:视频时序产生

  3. jQuery实现点赞动态效果

    实现动态效果基本上都是用到定时器,修改标签的位置大小颜色属性 <!DOCTYPE html> <html lang="en"> <head> & ...

  4. MIME 设置

    1,打开iis7,选择你要设置网站,打开mime类型选项 2,找到.rar的mime类型,复制他的类型 3,复制后选项添加,在文件扩展名那一栏填入.*,然后在下面的mime类型复制你刚复制的appli ...

  5. inf 启动

    How to install an INF file using Delphi If you need to install an "inf" file using Delphi, ...

  6. Java课程设计(2019版)

    参考资料 Java课程设计参考资料(2018-12-26更新) Java课程设计常见问题(程序部署.数据库.JSP) 项目开发参考-阿里巴巴Java开发手册(正式版) 更多参考资料请查看QQ群文件中的 ...

  7. PREV-4_蓝桥杯_剪格子

    问题描述 如下图所示,3 x 3 的格子中填写了一些整数. +--*--+--+|10* 1|52|+--****--+|20|30* 1|*******--+| 1| 2| 3|+--+--+--+ ...

  8. elasticsearch mapping demo

    curl -XPUT localhost:9200/local -d '{ "settings" : { "analysis" : { "analyz ...

  9. windows 下跟踪日志的几个工具总结

    1.baretailpro.exe 2.wintail.exe 3.vim(using tail bundle plugin) 4.Notepad++ (Plugin->Plugin Manag ...

  10. [Easyui - Grid]为easyui的datagrid、treegrid增加表头菜单,用于显示或隐藏列

    为easyui的datagrid.treegrid增加表头菜单,用于显示或隐藏列 /** * @author 孙宇 * * @requires jQuery,EasyUI * * 为datagrid. ...