Sign inSign up

ecoding/apidoc-publisher

By ecoding

•Updated over 6 years ago

CODING API-DOC Page Builder

Image
0

2.3K

ecoding/apidoc-publisher repository overview

⁠CODING API-DOC Page Builder

⁠Intro

This image help users to upload openapi 2.0/openapi 3.0/postman 1.0/postman 2.x to CODING⁠ and build a Api Doc page

⁠Use

访问令牌 can take from CODING⁠ , its project deploy token or personal token is valid (you must set right token scope about api-doc)

文本形式

docker run -it --rm \
  -e ACCESS_TOKEN={访问令牌} \
  -e APIDOC_TEAM=codingcorp \
  -e APIDOC_PROJECT=test-new-feie \
  -e APIDOC_ID=5 \
  -e APIDOC_RELEASE_TYPE=content \
  -e APIDOC_CONTENT={API 数据内容} \
  ecoding/apidoc-publisher

上传文件形式 this way is the best practice

docker run -it --rm \
  -e ACCESS_TOKEN={访问令牌} \
  -e APIDOC_TEAM=codingcorp \
  -e APIDOC_PROJECT=test-new-feie \
  -e APIDOC_ID=5 \
  -e APIDOC_RELEASE_TYPE=file \
  -v {API 数据文件路径, 其中数据必须保存在 data.txt 中}:/opt \
  ecoding/apidoc-publisher

Tag summary

Content type

Image

Digest

Size

3.8 MB

Last updated

over 6 years ago

docker pull ecoding/apidoc-publisher