在上一篇文章中,我们讲解了什么是 api,什么是 sdk: https://www.cnblogs.com/tanshaoshenghao/p/16217608.html 今天将来到我们万丈高楼平地起系列文章的第二篇:如何编写 api 文档? 咳咳,其实写 api 文档这个事情也没有一个统一的标准,写这篇文章更多地是分享与记录自己的一些心得体会. 曾经有大佬和我说,通过一个人的 api 设计大概率能看出他的工程水平,并且推荐我去看一些优秀的 api 设计,比如 aws 的 api. 后来我感觉,…

MinDoc是什么? MinDoc是一个在线的文档管理系统,该系统适用于团队.个人等使用.开发者最初的目的是为了便于公司内部使用,仿照看云开发.有laravel版本以及golang版本.不过laravel版本部署起来相当麻烦,因为到搭建PHP开发环境还需要自己配置,加上精力有限,暂停了laravel的研发.本文中用golang版本介绍如何安装,安装教程其实在GitHub是有的,但是在安装中,发现作者有几个地方写的不够完善,特此记录此文. 如何获取MinDoc 官网,github,wiki,代码下…

在PHPer中,很多人听说过Swagger,部分人知道Swagger是用来做API文档的,然而只有少数人真正知道怎么正确使用Swagger,因为PHP界和Swagger相关的资料实在是太少了.所以鄙人斗胆一试,希望能以本文帮助到大家了解Swagger,从此告别成天用Word.Markdown折腾API文档的日子. 什么是Swagger Swagger is a simple yet powerful representation of your RESTful API. With the lar…

提供一个国内可以访问的 angularjs API文档站点 http://i.frllk.com/ 文档直接在 github 上下载的: https://github.com/angular-cn/ng-docs-en 空间是万网赠送的 2年时间,本来也没有用处所幸共享出来当成api站点用 另外提供一个免FQ上Google的网站 http://www.glgoo.com 好了现在开始抒发我内心挤压已久的不满了. 墙! 墙! 墙 到处墙 你们到底有多少见不得光的事情.…

相信很多同人和我一样,想去官网下载一份纯英文的java API文档,可使sun公司的网站让我实在很头疼,很乱,全是英文!所以就在网上下载了别人提供的下载!可是还是不甘心!其实多去看看这些英文的技术网站很有好处!去官网下载的东西感觉也很好! 所以: 1.进入官网http://www.oracle.com/technetwork/java/index.html 2.Oracle主页 -> download下拉菜单里找到Java for development -> 按ctrl+F搜索Java SE…

Api 文档管理系统 RAP2 环境搭建  发表于 2018-03-27 |  分类于 Api |  评论数: 4|  阅读次数: 4704  本文字数: 4.8k |  阅读时长 ≍ 9 分钟 RAP2 是采用前后端分离的形式,因此搭建完整的 RAP2 需要 服务端:rap2-delos,客户端:rap2-dolores 同时部署 部署 RAP2 需要亲具有 Node+Linux+MySQL 的运维知识,如果亲对此不是很了解,建议用 http://rap2.taobao.org 线上版本就可以…

Java学习资料(适合c转java的同学): Java中带包(创建及引用)的类的编译 - 小明快点跑 JAVA 对象引用,以及对象赋值 - 飘来荡去. Java官网下载页:https://www.oracle.com/technetwork/java/javase/downloads/index.html 翻到最下面,找到Java SE <你所用的版本号> Document,然后下载即可 下载了一个zip后解压,然后在解压的文件夹里的各子目录找到各个index.html,打开后即可查阅,最好是…

.Net Core3.0 WebApi 项目框架搭建:目录 为什么使用Swagger 随着互联网技术的发展,现在的网站架构基本都由原来的后端渲染,变成了:前端渲染.后端分离的形态,而且前端技术和后端技术在各自的道路上越走越远. 前端和后端的唯一联系,变成了API接口:API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架. 没有API文档工具之前,大家都是手写API文档的,在什么地方书写的都有,有在confluence上写的,有在对应的项目…

Java,面试题,简历,Linux,大数据,常用开发工具类,API文档,电子书,各种思维导图资源,百度网盘资源BBS论坛系统 ERP管理系统 OA办公自动化管理系统 车辆管理系统 家庭理财系统 各种后台系统 一.面试题.简历资源 二.各类思维导图 三.大数据学习 四.Linux 五.各类常用开发工具类 六.百度网盘各类资源,包含java开发,项目实战,MYSQL,框架学习,大数据,Linux等等,应有尽有 百度网盘面试题资源 MySQL数据库 七.管理系统 程序员的道路,是一个不断不断不断学习的…

目录 前言 Swagger NuGet引用第三方类库 别急,还有 没错,注释 小结 前言 前后分离的好处,就是后端埋头做业务逻辑功能,不需要过多考虑用户体验,只专注于数据.性能开发,对于前端需要的数据可以通过组Json或者其他方式回调,但是前后两端需要确定好接口Api的规范,并且前端如果需要查看接口的相关信息,就需要文档的支撑了.那么问题来了,后端在开发过程中每次改动接口,都需要改动文档,累不累. Swagger Swagger作为一个在线文档,通过后端的接口控制器生成一套Json串数据,实时展…