https://github.com/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.
https://github.com/apicat/apicat

api api-documentation api-generation apicat documentation-tool gpt llm openapi swagger

Last synced: 26 days ago
JSON representation

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.

• Host: GitHub
• URL: https://github.com/apicat/apicat
• Owner: apicat
• Created: 2022-05-05T06:44:36.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-23T02:54:37.000Z (about 1 month ago)
• Last Synced: 2024-05-23T04:54:04.135Z (about 1 month ago)
• Topics: api, api-documentation, api-generation, apicat, documentation-tool, gpt, llm, openapi, swagger
• Language: Go
• Homepage: https://apicat.ai
• Size: 11 MB
• Stars: 247
• Watchers: 7
• Forks: 29
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Lists

• awesome-stars-eryajf - 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. (Go)
• awesome-ops - apicat/apicat - 05-05|2024-04-30 | 一款基于 AI 技术的 API 开发工具，它旨在通过自动化和智能化的方式，帮助开发人员更快速、更高效地开发 API | (接口管理)
• awesome - 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. (Go)

README

        


    





  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](https://apicat.ai) 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](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) are installed on your machine:

```bash

docker compose up -d

```

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

If you need to customize the configuration, please refer to our [docker-compose.yml](./docker-compose.yaml) 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](https://discord.gg/6UFBGhNu)

## License

[MIT](https://github.com/apicat/apicat/blob/main/LICENSE)