# showdoc-api-plugin
**Repository Path**: chansirs/showdoc-api-plugin
## Basic Information
- **Project Name**: showdoc-api-plugin
- **Description**: No description available
- **Primary Language**: Go
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 0
- **Created**: 2021-08-23
- **Last Updated**: 2024-07-28
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# showdoc-api-plugin
## 介绍
showdoc-api-plugin是一款基于[showdoc](https://www.showdoc.com.cn)文档管理平台开发的api接口文档快速生成插件。
支持：
- swagger 2.0
- openapi 3.0
## 主要功能点
快速并完整的解析项目中基于[swagger](https://swagger.io/tools/swagger-ui) 制作的接口信息，将信息同步到[showdoc](https://www.showdoc.com.cn)文档管理平台中，以清晰明了的文档格式进行展示，并借助于showdoc工具强大的文档管理能力，支持了文档的分享、导出(word)与团队协作，更加易于后期的维护与沟通。
## 安装教程
1. api-swagger.exe(windows)
2. api-swagger(linux)
## 参数说明
1. ```-host``` show-doc服务器地址,可以是一个IP+PORT地址，也可以是一个域名地址,例:http://127.0.0.1:8080或http://www.baidu.com
2. ```-key``` api_key，认证凭证。登录show-doc，进入具体项目后，点击右上角的”项目设置”-“开放API”便可看到
3. ```-swagger``` 可用的Swagger JSON http(s)地址或swagger.json文件的绝对路径
4. ```-token``` api_token,认证凭证。登录show-doc，进入具体项目后，点击右上角的”项目设置”-“开放API”便可看到
**示例：**
```shell
./api-swagger.exe -host http://127.0.0.1:8080 -key 03f9cd27d52d3f8799b205f722fdb5ad1444746704 -token 08a4da5c123550d6a77e46ce479c35fe80738039 -swagger https://petstore.swagger.io/v2/swagger.json
```
# 页面内容预览示例:
## Find purchase order by ID
### 简要描述
For valid response try integer IDs with value >= 1 and <= 10. Other values will generated exceptions
### 请求URL
- ` http(s)://petstore.swagger.io/v2/store/order/{orderId} `
### 请求方式
- get
**请求参数**
|参数名|参数类型|必选|类型|说明|
|:---- |:-----|:---|:----- |----- |
|orderId |path |true |int64 |ID of pet that needs to be fetched |
### 请求响应
- ` 200 `
**返回示例**
```
#200
{
"complete": false,
"id": 0,
"petId": 0,
"quantity": 0,
"shipDate": "date-time",
"status": ""
}
```
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|-----
|petId |int64 |- |
|quantity |int32 |- |
|shipDate |date-time |- |
|status |string |Order Status |
|complete |boolean |- |
|id |int64 |- |
- ` 400 `
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|-----
|400 |object |Invalid ID supplied |
- ` 404 `
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|-----
|404 |object |Order not found |
### 备注
- 暂无备注
## Place an order for a pet
### 简要描述
### 请求URL
- ` http(s)://petstore.swagger.io/v2/store/order `
### 请求方式
- post
**请求参数示例**
```
#body
{
"complete": false,
"id": 0,
"petId": 0,
"quantity": 0,
"shipDate": "date-time",
"status": ""
}
```
**json字段说明**
|参数名|必选|类型|说明|
|:---- |:---|:----- |----- |
|shipDate |false |date-time |- |
|status |false |string |Order Status |
|complete |false |boolean |- |
|id |false |int64 |- |
|petId |false |int64 |- |
|quantity |false |int32 |- |
### 请求响应
- ` 200 `
**返回示例**
```
#200
{
"complete": false,
"id": 0,
"petId": 0,
"quantity": 0,
"shipDate": "date-time",
"status": ""
}
```
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|-----
|petId |int64 |- |
|quantity |int32 |- |
|shipDate |date-time |- |
|status |string |Order Status |
|complete |boolean |- |
|id |int64 |- |
- ` 400 `
**返回参数说明**
|参数名|类型|说明|
|:----- |:-----|-----
|400 |object |Invalid Order |
### 备注
- 暂无备注
# 导出文档预览示例：
