🚀 Socket Launch Week Day 5:Introducing Repository Access Permissions and Custom Roles.Learn more
Sign In

yapi-plugin-api-doc

Package Overview
Dependencies
Maintainers
1
Versions
9
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

yapi-plugin-api-doc

在标签页中加入查看接口文档

Source
npmnpm
Version
0.1.0
Version published
Weekly downloads
11
1000%
Maintainers
1
Weekly downloads
 
Created
Source

yapi-plugin-api-doc

根据内置导出数据插件,在分组的某个项目导航栏中加入接口文档标签,点击可以直接查看接口文档。

第一步:在config.json 这层目录下运行 yapi plugin --name yapi-plugin-api-doc 安装插件

第二步: 重启服务器

特性

项目接口文档

点击项目导航栏的接口文档,可以设置查看当前分组所有接口的文档。页面顶部有一个开关,用来设置当前分组的开放接口文档是否公开可见,打开开关之后可以看到公开访问地址。

每个接口编辑页面都可以设置当前接口是否为开放接口,如果是开放接口可以通过这边的设置来觉得是否开放为无需登录即可访问的接口。

全局接口文档

对于一个工程中有很多分组,一个分组又会有很多项目,这些分组和项目之间对外提供文档是需要一定顺序的。 点击右上角的头像会出现下拉选项,点击接口文档即可进入全局文档的设置界面。 当前支持在目录树上进行拖拽排序操作,轻松搞定文档的顺序。通过右侧给出的文档地址可以轻松访问。

公开访问

目前的YAPI不支持用户不登录进行访问操作,需要支持public接口的版本才能免登录公开访问

Keywords

yapi

FAQs

Package last updated on 20 Nov 2019

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts