apicat / apicat

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.

English | 简体中文

ApiCat is an API documentation management tool that is fully compatible with the OpenAPI specification. With ApiCat, you can freely and efficiently manage your APIs. It integrates the capabilities of LLM, which not only helps you automatically generate API documentation and data models but also creates corresponding test cases based on the API content. Using ApiCat, you can quickly accomplish anything outside of coding, allowing you to focus your energy on the code itself.

Using our Cloud Services

You can try out ApiCat now. It provides all the capabilities of the self-deployed version.

Local Installation

The easiest way to start the ApiCat is to run our docker-compose.yaml file. Before running the installation command, make sure that Docker and Docker Compose are installed on your machine:

docker compose up -d

After running, you can visit http://localhost:8000 on your browser to start using ApiCat.

If you need to customize the configuration, please refer to our docker-compose.yml file and manually set the environment configuration. After making the changes, please run docker-compose up -d again.

Community

If you have anything you would like to discuss with us, please join our community.

• Discord

License

MIT

apicat's Issues

文档导出功能还是要的,有时候要分享给别人对接,不方便直接给在线地址.

如题,就像之前的版本那样能导出pdf,md,最好也能导出 html

Add mock support

Feature Description

• Add a generic data mock UI
• Debugging can be invoked remotely from the real address

Failed to create project with title in chinese characters.

Error Message found in log:
time="2023-07-20 16:12:04" level=ERROR msg="gorm.trace err:Error 1366 (HY000): Incorrect string value: '\xE7\x94\xA8\xE6\x88\xB7...' for column 'title' at row 1" sql="INSERT INTO projects (public_id,title,visibility,share_password,description,cover,created_at,updated_at,deleted_at) VALUES ('Eqk3LJZCE4guKvjTjxqU8D','用户中心（UC）',1,'','','{"type":"icon","coverBgColor":"#66CCCC","coverIcon":"ac-fangkuai"}','2023-07-20 16:12:04.46','2023-07-20 16:12:04.46',NULL)" rows=0 latency=2.132578ms

Support for importing postman

todo

Online Demo

请问 Demo 的账号密码是多少呢？最好放在文档里，新接触项目的可以更流程地开始体验

pnpm build error

node: v16.15.0
pnpm:7.12.2

when execute pnpm build get error

@apicat/website:build: src/components/PopperMenu.vue(5,13): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(6,44): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(6,79): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(7,27): error TS2345: Argument of type 'unknown' is not assignable to parameter of type 'Menu'.
@apicat/website:build: src/components/PopperMenu.vue(9,16): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(9,75): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(10,22): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(10,55): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(10,82): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(11,18): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(11,71): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build: src/components/PopperMenu.vue(12,10): error TS18046: 'menu' is of type 'unknown'.
@apicat/website:build:  ELIFECYCLE  Command failed with exit code 2.

can't login if database is sqlite

type Users struct {
ID uint gorm:"type:**bigint**;primaryKey;autoIncrement"

sqlite field can be set as autoIncrement only if the type is integer and primary key

导入和mock支持 Allof 、oneof 、anyOf

导入的yaml中支持schema组合模式