Doke

(preview)

Overview

Doke is an API documentation generator similar to Swagger but with a stronger focus on design. Its goal is to provide more professional and visually appealing documentation when sharing API specifications with other companies or developers.

Key Features

• Beautiful Design: Provides a visually superior UI compared to Swagger
• User-Friendly Interface: Intuitive navigation and document structure
• Easy Integration: Seamlessly integrates with NestJS
• Custom Decorators: Provides an easy way to document API endpoints in your code
• Automatic Documentation Generation: Automatically generates documentation from API endpoints

Getting Started

Installation

# Using npm
npm install doke-nest

# Using yarn
yarn add doke-nest

Usage

For detailed usage instructions and examples, please check our TodoList example project: TodoList Example

Supported Frameworks

Currently, only NestJS is officially supported. However, any language or framework can use doke-ui as long as it can generate documentation in the required JSON format.

Future Framework Support

We plan to support more frameworks and languages in the future. Currently, our focus is on integration with NestJS.

Contributing

Contributions are always welcome! Please follow these steps:

1. Fork this repository
2. Create a feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is open source.

Contact

If you have any questions, please open an issue on GitHub.