API文档管理工具-数据库表结构思考. PS: 管理工具只是为了方便自己记录API的一些基本信息,方便不同的开发人员 (App Developer, Restful API Developer)之间的工作协调,同时也是由于本人不擅长word文档编写,程序及设计简单,大牛勿喷! API基础信息表 CREATE TABLE API_Infor ( ApiID uniqueidentifier PRIMARY KEY ,ApiCategory int ,ApiSupport nvarchar() ,A…

问题: 不同软件/程序在网络中互相传递信息不统一. 交互不便. REST API 作用: RESTful API就是一套协议,用来规范多种形式的前端和同一个后台的交互方式. 原理: 组成/流程/规范: 遵守OpenAPI规范 软件的REST API文档 问题: 在API的迭代开发过程中,文档更新工作容易遗漏. swagger框架 功能: 生成遵守OpenAPI规范的.JSON或YAML格式的RESTful API文档. 实现: 读取嵌入到源代码中的api文档,生成api文档. swagger规范…

系统庞大之后,前后端分离开发,前端调用后端提供的接口,请求协议一般是 HTTP,数据格式一般是 JSON.后台只负责数据的提供和计算,而完全不处理展现逻辑和样式:前端则负责拿到数据,组织数据并展现的工作.这样结构清晰,关注点分离,前后端会变得相对独立并松耦合.好处多多. 但是这样带来很多问题,前端可能需要拿到后端的数据之后,才能开始开发工作,等前端开发完成之后,然后再与后端一起联调.耗时不说,如果业务的需求更改,后端接口变更,怎么快速便捷告知前端的开发人员?还有其他如文档维护和及时更新的问题.这…

Simple doc是一个简易的文档发布管理工具,为什么要写Simple doc呢?主要原因还是github的wiki并不好用:没有目录结构,文章没有Hx标签索引,最悲剧的是文章编辑的时候不能直接图片粘贴和文件上传;为了满足自己的需求也顺带帮Beetlex写个完整的web示例所以花了些时间写了Simple doc.虽然Simple doc功能简单但在文档展现上还是要比github的wiki好上不少,所以在完成后也把github的wiki迁到这上面来了(毕竟都是基于markdown所以迁过来也简单…

前言介绍 Yapi 由 YMFE 开源,旨在为开发.产品.测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建.发布.维护 API. 权限管理 YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求 可视化接口管理 基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率 Mock Server 易用的 Mock Server,再也不用担心 mock 数据的生成了 自动化测试 完善的接口自动化测试,保证数据的正确性 数据导入 支持导入…

今天各种MVC框架满天飞,大大降低了编码的难度,写实体类就没有办法回避的一件事了,花大把的时间去做一些重复而且繁琐的工作,实在不是一个优秀程序员的作风,所以多次查找和尝试后,找到一个工具类网站——Api管家 这也太直白了,卡通的背景,好像不怎么样...先试用看看 好吧,先创建个试试 果然出现了一个项目,进去看看 5个接口的示例,看起来还挺清爽,+1分,随便点点... 好多按扭啊...点点看,代码生成在哪里啊... 这个是什么鬼!有毛用... 再试试... 进编辑了... 慢点再研究,继续找...…

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

上周看到有人在我的Github开源项目中提了个issue,说是否考虑接入swagger.那今天我就用swagger与其他接口文档工具做对比,同时说说Api接口文档工具的那点事.如今,在前后端分离开发的这个年代,Api接口文档管理工具越来越显得重要.完整的Api接口文档能大大提升前后端开发协作的效率. image 目前市场有哪些比较优秀的接口文档管理工具呢?Swagger Api接口文档工具到底如何,我大致汇总一下吧! 一.Swagger 说到Swagger,他确实是为开发者发明的一款神器,他可以…

项目背景 公司业务历史悠久且复杂,数据库的表更是多而繁杂,每次基于老业务做功能开发都需要去翻以前的表和业务代码.需要理解旧的表的用途以及包含的字段的含义,表少还好说,但是表一多这就很浪费时间,而且留下来的文档都是残缺不全,每次查一些表的含义都要捯饬很久.在网上搜索关于数据库文档管理工具搜到最多的就是Screw和DBCHM,一个是基于Java的工具.另一个则是bug很多,表一多就一直转圈圈进不去.所以自己就动手开发了这款SmartSQL的工具. 它是一款基于.Net 4.6.1.WPF开发的一款数…

系列目录 基于WPF重复造轮子,写一款数据库文档管理工具(一) 本篇重点 上次发表了基于WPF重复造轮子,写一款数据库文档管理工具(一) 得到不少人支持,文章一度上到了博客园推荐表首页,看来大家对这个工具还是很喜欢.今天就继续来分享一下我在开发这款工具的过程中积累的一些技术点. 本篇主要讲的是基于HandyControl控件的DataGrid进行数据绑定以及如何实现自定义一个自定义控件.在写这些之前我们先来看下我们工具的整个界面: 今天我们要实现的就是右边主界面展示的列表区域,其实这个区域是由多…