Features

• Centralized API documentation and developer tools
• Perfectly optimized for APIs based on domain-driven-design
• Perfectly optimized for CI/CD driven documentation
• Single-Page application based on Angular
• Customizable content, themes and styles
• Webhosting or Dockerized deployment for easy hosting

Demo

See the Coffe & Fruits Store Demo Website.

Try out local with Docker Compose by runnung:

docker compose -f demo.docker-compose.yml up --build --force-recreate

Documentation

See the API Whisperer Documentation.

Getting started

Create a new application by running:

npx create-api-whisperer my-developer-portal

For more details refer to the API Whisperer Documentation.

Building from Source

This project was generated with Angular CLI.

Building

Overwrite environments at /src/environments or configuration at /src/assets and run ng build --configuration production to build a new application.

Development server

Run ng serve for a dev server. Navigate to http://localhost:4200/. The application will automatically reload if you change any of the source files.

Code scaffolding

Run ng generate component component-name to generate a new component. You can also use ng generate directive|pipe|service|class|guard|interface|enum|module.

For Contributors

Please submit an Issue.

📄 License

This project is licensed under a Customized MIT License!

• ✅ Free for personal use and small businesses
  (fewer than 10 employees and under €2M annual revenue)
• ❌ Not permitted for resale, commercial SaaS, or use by larger organizations
• 📬 Commercial licenses available

Please refer to the LICENSE.txt file for full terms and conditions.

Powered by Steidler IT-Consulting

Made with ❤️ in Germany!