在线api接口文档在哪（api接口文档生成工具）

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

本文目录一览：

• 1、如何查看android api？
• 2、java的api在哪里？
• 3、YApi~API接口文档
• 4、如何使 WebAPI 自动生成漂亮又实用在线API文档
• 5、android sdk api文档在哪

如何查看android api？

1、在电脑浏览器中百度搜索Android SDK API文档，找到Android SDK | Android中文API选项并点击进入。

2、会来到一个新的页面，在左侧的菜单里面选择Developer Tools这一项。

3、等在开发工具那里看到Android Studio以后，直接选择参考这个窗口进行点击。

4、这样一来如果没问题的话，即可查看android api了。

java的api在哪里？

JAVA API(Java Application Interface)是JAVA的应用编程接口。作为Sun开发的Java程序，用于Java编程人员使用的程序接口，并不是说使用Java和接口有关，而是表示Java所提供的现成的类库，供编程人员使用。这与 Win32 中的 dll 文件有点像，封装了好多函数，只暴露也函数名、参数等信息，不提供具体实体，暴露出来的这些就称为API了。也就是说 Java 也是封装了好多的方法，提供了些方法名和参数等信息，便于别人使用啊。由于Java是开源的，还可是看到类库中方法的具体实现。
JAVA API官方文档中文版(CHM):每个已文档化的软件包、类和接口都有各自的“使用”页面。此页面介绍了使用给定类或软件包的任何部分的软件包、类、方法、构造方法和字段。对于给定的类或接口 A，其“使用”页面包含 A 的子类、声明为 A 的字段、返回 A 的方法，以及带有类型为 A 的参数的方法和构造方法。

YApi~API接口文档

YApi

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

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

安装过程就不做复述了，文档写的非常全

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

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

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

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

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

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

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

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

如何使 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 文档展示效果

android sdk api文档在哪

默认在Android SDK安装目录的docs\reference\packages.html下。下面是Android的sdk、api及工程目录说明：
SDK下包的说明：
1：add-ons：Android开发需要的第三方文件和软件库
2：docs：Android的文档。包括开发指南、API参考、资源等
3：extras：扩展的附加包
4：platforms：你安装下载的所有Android平台，分版本存放
5：platform-tools：平台相关的工具
6：samples：所有的样例程序
7：system-images：系统使用的图片
8：temp：临时操作或缓存的目录
9：tools：应用Android平台进行开发所需要的一些开发工具
常见的api包说明：
1：android.app ：提供高层的程序模型、提供基本的运行环境
2：android.content ：包含各种的对设备上的数据进行访问和发布的类
3：android.database ：通过内容提供者浏览和操作数据库
4：android.graphics ：底层的图形库，包含画布，颜色过滤，点，矩形，可以将他们
直接绘制到屏幕上.
5：android.location ：定位和相关服务的类
6：android.media ：提供一些类管理多种音频、视频的媒体接口
7：android.net ：提供帮助网络访问的类，超过通常的java.net.* 接口
8：android.os ：提供了系统服务、消息传输、IPC 机制
9：android.opengl ：提供OpenGL 的工具
10：android.provider ：提供类访问Android 的内容提供者
11：android.telephony ：提供与拨打电话相关的API 交互
12：android.view ：提供基础的用户界面接口框架
13：android.util ：涉及工具性的方法，例如时间日期的操作
14：android.webkit ：默认浏览器操作接口
15：android.widget ：包含各种UI 元素（大部分是可见的）在应用程序的屏幕中使用 关于在线api接口文档在哪和api接口文档生成工具的介绍到此就结束了，不知道你从中找到你需要的信息了吗 ？如果你还想了解更多这方面的信息，记得收藏关注本站。 在线api接口文档在哪的介绍就聊到这里吧，感谢你花时间阅读本站内容，更多关于api接口文档生成工具、在线api接口文档在哪的信息别忘了在本站进行查找喔。

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