Api文档

eoLinker-AMS接口管理系统 环境管理教程

試著忘記壹切 提交于 2021-01-13 07:18:50
环境管理 eoLinker AMS 提供了目前最强大的 项目环境管理 功能,您可以通过它实现: 一键修改所有API接口的请求前缀(Base URL/根路径) 加上统一Header 加上统一请求参数 通过全局变量动态改变所有接口中的请求参数值等 创建环境 进入环境管理页面,点击添加环境按钮,输入相关的环境名称(如测试环境、生成环境等): 点击 保存 或 继续添加 即可创建一个新的 项目环境 。 修改环境 鼠标点击需要修改的 环境 ,在右侧直接修改相关的内容,点击保存即可: 删除环境 当鼠标放置于 环境 上时,右侧会出现 隐藏的菜单按钮 : 点击之后选择 删除 按钮,即可删除该环境: ------------------------------------------------------------------------------------------------------------ 修改根路径(Base Url) eoLinker AMS 提供了目前最强大的 项目环境管理 功能,您可以通过它实现一键修改所有API接口的请求前缀(Base URL/根路径): 创建环境之后,填写 前置URL 后保存设置: 在 接口列表页面 或 接口详情页 点击页面右上角 切换环境菜单 ,选择想要切换的 环境 ,会发现API的路径已经自动加上环境的前置URL了: --------------

eoLinker-AMS接口管理系统 API文档管理教程

淺唱寂寞╮ 提交于 2020-11-17 05:51:12
创建接口分组 在eoLinker中,您可以为接口创建相应的分组以方便管理,AMS支持最多二级的接口分组。 创建分组 在API接口页面,点击分组侧边栏上方的 新建分组 按钮: 在弹出框中输入相关信息即可创建一个接口分组: 创建子分组 当鼠标放置于分组上时,右侧会出现 隐藏的菜单按钮 : 点击之后选择 添加子分组 按钮,在弹出框中输入相关信息即可创建一个接口分组: 为什么不支持更多级分组? 经过实际的调研,当接口分组超过三级时,接口的管理/搜索效率反而是降低的,因此我们建议您如果项目的接口非常多,分级也比较复杂时,将项目合理拆分为几个项目会更好一些,比如拆分为用户系统、支付系统等。 ------------------------------------------------------------------------------------------------------------ 修改/删除接口分组 当鼠标放置于分组上时,右侧会出现 隐藏的菜单按钮 : 点击之后选择 修改 或 删除 按钮即可: ------------------------------------------------------------------------------------------------------------ 创建API接口 在项目详情页,点击侧边栏 API接口

Swagger-UI 基于REST的API测试/文档类插件

若如初见. 提交于 2019-12-09 16:50:17
现在多数的项目开发中,网站和移动端都需要进行数据交互和对接,这少不了使用REST编写API接口这种场景。例如我目前的工作,移动端交由了另一团队开发,不同开发小组之间就需要以规范和文档作为标准和协作基础。良好的文档可以让开发事半功倍,而作为又懒又要效率又能交代的码农,当然最希望一切自动化,或用小聪明来找到最适合的工具。 Swagger-UI简单而一目了然。它能够纯碎的基于html+javascript实现,只要稍微整合一下便能成为方便的API在线测试工具。项目的设计架构中一直提倡使用TDD(测试驱动)原则来开发,swagger-ui在这方面更是能提供很大帮助。 Swagger-UI更倾向于在线测试接口和数据,但其核心是一个javascript插件,只要稍作修改,便能按需求定制出不同格式的说明文档,在github上更是基于它集成到各种语言环境,分支众多。 其官方提供了一个离线版本,其使用方法十分简单:直接在js格式的资源文件中录入REST API的json信息,便能容易地生成不同模块下的API列表,每个API接口描述和参数、请求方法都能在每个json数组中定制。下面是目前项目中使用到的部分预览图: Swagger-UI 的官方地址: http://swagger.wordnik.com Github上的项目地址: https://github.com/wordnik/swagger

【开源】.Net Api开放接口文档网站

孤街浪徒 提交于 2019-12-03 11:34:14
开源地址: http://git.oschina.net/chejiangyi/ApiView 开源QQ群: .net 开源基础服务 238543768 ApiView .net api的接口文档查看网站,用于解决 分布式开发 过程中的Api接口管理和沟通问题。 - 自动生成api文档; - 方便api调试及第三方开发人员对接,可以应用在asp.net mvc,wcf,webservice 中使用; - 代码及原理都很简单,方便二次开发和完善。 by 车江毅 安装包 使用git下载项目并打开目录 “\安装包\” 可直接安装使用 使用Demo示例 1 using System; 2 using System.Collections.Generic; 3 using System.Linq; 4 using System.Web; 5 using System.Web.Mvc; 6 using BSF.BaseService.OpenApi.Attributes; 7 using BSF.Extensions; 8 using BSF.Api; 9 10 namespace ApiViewTestWeb.Controllers 11 { 12 public class DemoController:Controller 13 { 14 // 15 // GET: /Demo/ 16