apicat 接口文档工具 apicat

afocus2023-05-22 18:34:59 • 2285 次点击    
这是一个分享于 2023-05-22 18:34:59 的项目,其中的信息可能已经有所发展或是发生改变。

ApiCat

English | 简体中文

ApiCat is an API development tool based on AI technology, which aims to help developers develop APIs more quickly and efficiently through automation and intelligence. ApiCat supports the import and export of OpenAPI and Swagger data files, and can analyze and identify the API requirements entered by users, and automatically generate corresponding API documents and codes.

You can visit our Online Demo to try it out.

ApiCat is still in its early stages, Star and Watch are welcome to follow the latest developments of the project.

Features

Demo

AI-generate-schema

AI-generate-api-by-schema

AI-generate-api

Overview

  • Support OpenAPI and Swagger data file import and export, which is convenient for developers to describe and manage API specifications.
  • Through AI technology, the requirements and structure of the API can be automatically identified, and corresponding API documents and codes can be generated to improve development efficiency and quality.

Installation and deployment

Get Code

git clone https://github.com/apicat/apicat.git

Compile and start the service

# Enter project
cd apicat

# Compile the front-end code
cd fronted
pnpm install
pnpm build

# Update collation dependencies
go mod tidy

# Compile project
go build

# Modify the configuration file
# You can copy the configuration file content of config/setting.default.yaml for configuration modification
cp ./config/setting.default.yaml ./
vim ./setting.default.yaml

# start service(default configuration)
./apicat
# start service(custom configuration)
./apicat -c setting.default.yaml

Contact

The growth of ApiCat is inseparable from each of its users. If you have any content that you want to discuss with us, please contact us and join our WeChat discussion group through the QR code below.

Wechat Group

License

MIT

An efficient API documentation management tool that fully adheres to the OpenAPI specification and incorporates advanced LLM technology. This tool can automate the generation of API documentation, data models, and test cases, greatly enhancing development efficiency and documentation quality.Read More

Latest commit to the main branch on 11-18-2024
Download as zip
授权协议:
MIT
开发语言:
go 查看源码»
2285 次点击  
加入收藏 微博
暂无回复
添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传