项目和api接口说明文档（项目接口对接）

本篇文章给大家谈谈项目和api接口说明文档，以及项目接口对接对应的知识点，希望对各位有所帮助，不要忘了收藏本站喔。 今天给各位分享项目和api接口说明文档的知识，其中也会对项目接口对接进行解释，如果能碰巧解决你现在面临的问题，别忘了关注本站，现在开始吧！

本文目录一览：

• 1、YApi~API接口文档
• 2、什么是接口文档，如何写接口，有什么规范
• 3、关于API？
• 4、什么是API接口？主要作用是什么？
• 5、如何使 WebAPI 自动生成漂亮又实用在线API文档

YApi~API接口文档

YApi

地址链接： https://yapi.baidu.com/

文档链接： https://yapi.baidu.com/doc/documents/index.html

安装过程就不做复述项目和api接口说明文档了项目和api接口说明文档，文档写的非常全

在一个项目的开发过程之中，项目和api接口说明文档我相信基本上所有的开发人员都需要用到接口模拟请求的工具，例如POSTMAN啊

java的注解生成文档工具swagger啊

但是在实际开发过程中，前后端人员可能需要提前确定文档地址以及格式、参数等信息，

postman作为一个模拟请求的工具起不到记录功能

swagger只能通过注解、实体类、参数等信息生成文档，无法提前记录

这个时候就要提到Yapi中的运行这个功能了，只要安装一个chrome插件，马上实现在线调试功能

同时可以在设置中去配置一下环境设置，这样在开发过程中可以通过切换环境访问不同后端开发人员的本地开发环境，方便多人多模块同时调试

赤狐博客地址： https://blog.51chihu.com

什么是接口文档，如何写接口，有什么规范

接口文档一般是提供给商户对接时进行参考及提供帮助的一个说明文档或API。里面包含借口说明、接口列表、接口参数列表、签名/验签规则、商户应答规则等说明；
接口一般要首先考虑安全性，支付类的签名可以参考支付宝和微信支付这一类的接口文档，业务类的签名可以参考微信公众平台的接口API；
加签是根据商户号、业务参数、随机字符串或时间戳、商户密钥/公钥私钥等按照规则组装参数，然后按照一个签名规则生成签名，以保证接口的安全性；

关于API？

API(Application Programming Interface,应用程序编程接口)是一套用来控制Windows的各个部件(从桌面的外观到为一个新进程分配的内存)的外观和行为的一套预先定义的Windows函数.用户的每个动作都会引发一个或几个函数的运行以告诉Windows发生了什么.
这在某种程度上很象Windows的天然代码.其他的语言只是提供一种能自动而且更容易的访问API的方法.VB在这方面作了很多工作.它完全隐藏了API并且提供了在Windows环境下编程的一种完全不同的方法.
这也就是说,你用VB写出的每行代码都会被VB转换为API函数传递给Windows.例如,Form1.Print...VB 将会以一定的参数(你的代码中提供的,或是默认参数)调用TextOut 这个API函数.
同样,当你点击窗体上的一个按钮时,Windows会发送一个消息给窗体(这对于你来说是隐藏的),VB获取这个调用并经过分析后生成一个特定事件(Button_Click).
API函数包含在Windows系统目录下的动态连接库文件中(如User32.dll,GDI32.dll,Shell32.dll...).
API 声明
正如在"什么是API"中所说,API函数包含在位于系统目录下的DLL文件中.你可以自己输入API函数的声明,但VB提供了一种更简单的方法,即使用API Text Viewer.
要想在你的工程中声明API函数,只需运行API Text Viewer,打开Win32api.txt(或.MDB如果你已经把它转换成了数据库的话,这样可以加快速度.注:微软的这个文件有很多的不足,你可以试一下本站提供下载的api32.txt),选择"声明",找到所需函数,点击"添加(Add)"并"复制(Copy)",然后粘贴(Paste)到你的工程里.使用预定义的常量和类型也是同样的方法.
你将会遇到一些问题:
假设你想在你的窗体模块中声明一个函数.粘贴然后运行,VB会告诉你:编译错误...Declare 语句不允许作为类或对象模块中的 Public 成员...看起来很糟糕,其实你需要做的只是在声明前面添加一个Private(如 Private Declare Function...).--不要忘了,可是这将使该函数只在该窗体模块可用.
在有些情况下,你会得到"不明确的名称"这样的提示,这是因为函数.常量或其他的什么东西共用了一个名称.由于绝大多数的函数(也可能是全部,我没有验证过)都进行了别名化,亦即意味着你可以通过Alias子句使用其它的而不是他们原有的名称,你只需简单地改变一下函数名称而它仍然可以正常运行.
你可以通过查看VB的Declare语句帮助主题来获取有关Alias的详细说明.
消息(Messages)
好了,现在你已经知道什么是API函数了,但你也一定听说过消息(如果你还没有,你很快就会)并且想知道它是什么.消息是Windows告诉你的程序发生了哪些事件或要求执行特定操作的基本方法.例如,当用户点击一个按钮,移动鼠标,或是向文本框中键入文字时,一条消息就会被发送给你的窗体.
所有发送的消息都有四个参数--一个窗口句柄(hwnd),一个消息编号(msg)还有两个32位长度(Long)的参数.
hwnd即要接受消息的一个窗口的句柄,msg即消息的标识符(编号).该标识符是指引发消息的动作类型(如移动鼠标),另外两个参数是该消息的附加参数(例如当鼠标移动时光标的当前位置)
但是,当消息发送给你时你为什么看不到呢--就象有人在偷你的信一样?请先别恼火,让我告诉你.
小偷其实是Visual Basic.但它并没有偷走你的信,而是在阅读了之后挑出重要的以一种好的方式告诉你.这种方式就是你代码中的事件(Event).
这样,当用户在你的窗体上移动鼠标时,Windows会发送一条WM_MOUSEMOVE消息给你的窗口,VB得到这条消息以及它的参数并运行你在事件MouseMove中的代码,同时VB会把这条消息的第二个32位数(它包含了x,y坐标,单位为像素(Pixel),每个位16位)转换为两个单精度数,单位为缇(Twip).
现在,如果你需要光标坐标的像素表示,然而VB已经把它转换成了缇,因此你需要重新把它转换为以像素为单位.在这里,Windows给了你所需要的,但VB"好意地"进行了转换而使你不得不重新转换.你可能会问--我难道不能自己接收消息吗?答案是肯定的,你可以使用一种叫做子类处理(Subclass)的方法.但你除非必须否则最好不要使用,因为这与VB的安全程序设计有一点点的违背.(注:子类处理确实有很大的风险,但如果使用得当,是很有用处的.不过有一点一定要注意,即千万不要使用VB的断点调试功能,这可能会导致VB崩溃!)
需要补充说明的是:你可以发送消息给你自己的窗口或其他的窗口,只需调用SendMessage或PostMessage(SendMessage会使接受到消息的窗口立刻处理消息,而PostMessage是把消息发送到一个称为消息队列的队列中去,等候处理(它将会在该消息处理完后返回,例如有些延迟)).你必须制定接受消息的窗口的句柄,欲发送消息的编号(所有的消息的编号均为常量,你可以通过API Text Viewer查得)以及两个32位的参数。
API：应用程序接口（API：Application Program Interface）
应用程序接口（API：application programming interface）是一组定义、程序及协议的集合，通过 API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过使用 API 函数开发应用程序，从而可以避免编写无用程序，以减轻编程任务。
API 同时也是一种中间件，为各种不同平台提供数据共享。根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将 API 分为四种类型：
远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。
标准查询语言（SQL）：是标准的访问数据的查询语言，通过通用数据库实现应用程序间的数据共享。
文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。
当前应用于 API 的标准包括 ANSI 标准 SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些 API 以不同的格式连接数据（如共享数据缓存器、数据库结构、文件框架）。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的 API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种 API 只处理一种信息格式，所以该情形下的信息交付 API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付 API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付 API 类型是比较理想的选择。
API 与图形用户接口（GUI）或命令接口有着鲜明的差别：API 接口属于一种操作系统或程序接口，而后两者都属于直接用户接口。
有时公司会将 API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式 API。
另一种含义：
1：美国石油协会(API:American Petrolenm Institute)：
API610/682是机械密封的设计和选用标准；
API676 转子泵的标准；
2：API还有一种含意：空气污染指数。【英文 air pollution index 的缩写】
空气污染指数(AIR POLLUTION INDEX，简称API)是一种反映和评价空气质量的方法，就是将常规监测的几种空气污染物的浓度简化成为单一的概念性数值形式、并分级表征空气质量状况与空气污染的程度，其结果简明直观，使用方便，适用于表示城市的短期空气质量状况和变化趋势。
空气污染指数的确定原则：空气质量的好坏取决于各种污染物中危害最大的污染物的污染程度。空气污染指数是根据环境空气质量标准和各项污染物对人体健康和生态环境的影响来确定污染指数的分级及相应的污染物浓度限值。目前我国所用的空气指数的分级标准是：(1)空气污染指数(API)50点对应的污染物浓度为国家空气质量日均值一级标准；(2)API100点对应的污染物浓度为国家空气质量日均值二级标准；(3)API200点对应的污染物浓度为国家空气质量日均值三级标准；(4)API更高值段的分级对应于各种污染物对人体健康产生不同影响时的浓度限值，API500点对应于对人体产生严重危害时各项污染物的浓度。
根据我国空气污染的特点和污染防治工作的重点，目前计入空气污染指数的污染物项目暂定为：二氧化硫、氮氧化物和总悬浮颗粒物。随着环境保护工作的深入和监测技术水平的提高，再调整增加其它污染项目，以便更为客观地反应污染状况。
空气污染指数的计算与报告：
污染指数与各项污染物浓度的关系是分段线性函数(见表1和图1)，用内插法计算各污染物的分指数In(具体计算方法请参见《环境监测简报》1997年第9期)，取各项污染物分指数中最大者代表该区域或城市的污染指数。即：API＝max(I1,I2···Ii,···In)
该指数所对应的污染物即为该区域或城市的首要污染物。当污染指数API值小于50时，不报告首要污染物。
3：在JAVA中，API除了有应用“程序程序接口”的意思外，还特指JAVA API的说明文档，也称为JAVA帮助文档。
4.API Q1质量体系认证是您向用户证明您有一套API认可的完善的质量管理体系, 有些石油、天然气设备制造商所生产的产品目前没有所适用API会标产品的规范对应， 但他们又想向用户证明他们的产品或服务符合API标准的要求，所以API Q1质量体系认证可以帮您办到。API Q1质量体系认证特别适用于那些所生产的产品没有相应的API会标产品规范所对应的石油、天然气设备生产厂家， 或向石油、天然气行业提供服务的公司。
5.原料药（Active Pharmaceutical Ingredients）： 指的是药物活性成分，也就是我们通常所说的原料药。
另一种含义：
使用API（应用编程接口，英文全称：Application Programming Interface）构建业务是实现开放式业务结构的关键技术，也是下一代网络区别于传统电信网的主要特点之一。目前，关于下一代网络的开放式业务API标准主要包括：由Parlay组织、3GPP和ETSI SPAN共同制定的Parlay/OSA API以及由SUN公司在Java平台上推出的JAIN API。
Parlay API是由Parlay组织定义的便于业务开发者快速创建电信业务的应用编程接口，自1999年成立以来，Parlay组织已制定了4个版本的Parlay协议。开放式业务结构(OSA)是3GPP制定的多媒体业务框架，选定Parlay作为其开放式业务接口API。两者结合的Parlay/OSA API独立于具体的实现技术，可以应用于固定网络、移动网络以及下一代网络的业务提供；独立于具体的实现语言，可以用C、C++、Java等各种语言实现；定义了完善的认证和授权机制，以支持对第3方应用的支持。
Parlay/OSA API位于由网络运营商管理的Parlay网关和由业务提供商管理的应用服务器之间。Parlay网关对应用服务器屏蔽了下层网络的技术实现细节，使得应用服务器可以使用统一的方式对网络能力进行访问。
Parlay/OSA API包括两类接口：业务接口和框架接口。业务接口提供应用访问网络能力和信息的接口，框架接口提供业务接口安全、管理所必需的支持能力。业务接口保证用户能够接入传统网络，如呼叫控制、呼叫管理、发送消息、用户交互等；框架接口提供的功能有：业务登记、业务预订、业务发现、认证、授权和综合管理。
JAIN API和Parlay/OSA API设计思想相近，功能上具有互补性。它采用专一的Java语言实现，并且定义了比较完备的访问各种网络的网络协议API。目前Parlay/JAIN联合工作组正在进行两者的融合工作。
API：医药活性物原料药
参考资料：http://zhidao.baidu.com/question/71477404.html

什么是API接口？主要作用是什么？

API(Application
Programming
Interface,应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外，还特指
API的说明文档，也称为帮助文档。另外，也是美国石油协会、空气污染指数、医药、空中位置指示器的英文简称。
作为国内领先api卡类接口提供商（70卡世界），不仅支持现代电子商务活动中网银支付在线交易最典型和最成熟的支付方式，它功能齐全、覆盖范围广，货币流通顺畅，使用网银支付已是在线交易中最普遍最实用的一种方式。目前，70卡世界开拓出卡类支付通道，开通了最安全最广泛的交易快捷通道，有了网银支付这一功能，我们的在线交易就得到全面完善，从而就给人们带来多种多样的在线交易方式。已覆盖的卡类通道包括：神州行(地方)充值卡、神州行(全国)充值卡、
中国电信充值付费卡、联通全国充值卡、完美一卡通、骏网一卡通、搜狐一卡通、网易一卡通、
盛大一卡通、征途一卡通、久游一卡通、
QB卡、纵游一卡通、
蓝港一卡通等卡种，力求为70商户提供最专业最全的卡类支付通道。

如何使 WebAPI 自动生成漂亮又实用在线API文档

1.1 SwaggerUI
SwaggerUI 是一个简单的Restful API 测试和文档工具。简单、漂亮、易用（官方demo）。通过读取JSON 配置显示API. 项目本身仅仅也只依赖一些 html,css.js静态文件. 你可以几乎放在任何Web容器上使用。
1.2 Swashbuckle
Swashbuckle 是.NET类库,可以将WebAPI所有开放的控制器方法生成对应SwaggerUI的JSON配置。再通过SwaggerUI 显示出来。类库中已经包含SwaggerUI 。所以不需要额外安装。
2.快速开始
创建项目 OnlineAPI来封装百度音乐服务(示例下载) ，通过API可以搜索、获取音乐的信息和播放连接。
我尽量删除一些我们demo中不会用到的一些文件，使其看上去比较简洁。
WebAPI 安装 Swashbuckle
Install-Package Swashbuckle
代码注释生成文档说明。
Swashbuckle 是通过生成的XML文件来读取注释的，生成 SwaggerUI，JSON 配置中的说明的。
安装时会在项目目录 App_Start 文件夹下生成一个 SwaggerConfig.cs 配置文件，用于配置 SwaggerUI 相关展示行为的。如图：
将配置文件大概99行注释去掉并修改为
c.IncludeXmlComments(GetXmlCommentsPath(thisAssembly.GetName().Name));
并在当前类中添加一个方法
/// <summary
/// </summary
/// <param name="name"</param
/// <returns</returns
protected static string GetXmlCommentsPath(string name)
{
return string.Format(@"{0}\bin\{1}.XML", AppDomain.CurrentDomain.BaseDirectory, name);
}
紧接着你在此Web项目属性生成选卡中勾选 “XML 文档文件”，编译过程中生成类库的注释文件
添加百度音乐 3个API
访问 lt;youhost/swagger/ui/index,最终显示效果
我们通过API 测试API 是否成功运行
3.添加自定义HTTP Header
在开发移动端 API时常常需要验证权限，验证参数放在Http请求头中是再好不过了。WebAPI配合过滤器验证权限即可
首先我们需要创建一个 IOperationFilter 接口的类。IOperationFilter
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http;
using System.Web.Http.Description;
using System.Web.Http.Filters;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
public class HttpHeaderFilter : IOperationFilter
{
public void Apply(Operation operation, SchemaRegistry
schemaRegistry, ApiDescription apiDescription)
{
if (operation.parameters == null) operation.parameters = new
List<Parameter();
var filterPipeline =
apiDescription.ActionDescriptor.GetFilterPipeline();
//判断是否添加权限过滤器
var isAuthorized = filterPipeline.Select(filterInfo =
filterInfo.Instance).Any(filter = filter is IAuthorizationFilter);
//判断是否允许匿名方法
var allowAnonymous =
apiDescription.ActionDescriptor.GetCustomAttributes<AllowAnonymousAttribute().Any();
if (isAuthorized !allowAnonymous)
{
operation.parameters.Add(new Parameter
{
name = "access-key",
@in = "header",
description = "用户访问Key",
required = false,
type = "string"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<HttpHeaderFilter();
添加Web权限过滤器
using System;
using System.Collections.Generic;
using System.Linq;
using System.Net;
using System.Net.Http;
using System.Text;
using System.Web;
using System.Web.Http;
using System.Web.Http.Controllers;
using Newtonsoft.Json;
namespace OnlineAPI.Utility
{
/// <summary
///
/// </summary
public class AccessKeyAttribute : AuthorizeAttribute
{
/// <summary
/// 权限验证
/// </summary
/// <param name="actionContext"</param
/// <returns</returns
protected override bool IsAuthorized(HttpActionContext actionContext)
{
var request = actionContext.Request;
if (request.Headers.Contains("access-key"))
{
var accessKey = request.Headers.GetValues("access-key").SingleOrDefault();
//TODO 验证Key
return accessKey == "123456789";
}
return false;
}
/// <summary
/// 处理未授权的请求
/// </summary
/// <param name="actionContext"</param
protected override void HandleUnauthorizedRequest(HttpActionContext actionContext)
{
var content = JsonConvert.SerializeObject(new {State = HttpStatusCode.Unauthorized});
actionContext.Response = new HttpResponseMessage
{
Content = new StringContent(content, Encoding.UTF8, "application/json"),
StatusCode = HttpStatusCode.Unauthorized
};
}
}
}
在你想要的ApiController 或者是 Action 添加过滤器
[AccessKey]
最终显示效果
4.显示上传文件参数
SwaggerUI 有上传文件的功能和添加自定义HTTP Header 做法类似，只是我们通过特殊的设置来标示API具有上传文件的功能
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.Http.Description;
using Swashbuckle.Swagger;
namespace OnlineAPI.Utility
{
/// <summary
///
/// </summary
public class UploadFilter : IOperationFilter
{
/// <summary
/// 文件上传
/// </summary
/// <param name="operation"</param
/// <param name="schemaRegistry"</param
/// <param name="apiDescription"</param
public void Apply(Operation operation, SchemaRegistry schemaRegistry, ApiDescription apiDescription)
{
if (!string.IsNullOrWhiteSpace(operation.summary) operation.summary.Contains("upload"))
{
operation.consumes.Add("application/form-data");
operation.parameters.Add(new Parameter
{
name = "file",
@in = "formData",
required = true,
type = "file"
});
}
}
}
}
在 SwaggerConfig.cs 的 EnableSwagger 配置匿名方法类添加一行注册代码
c.OperationFilter<UploadFilter();
API 文档展示效果 关于项目和api接口说明文档和项目接口对接的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 项目和api接口说明文档的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于项目接口对接、项目和api接口说明文档的信息别忘了在本站进行查找喔。

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。