Automated API documentation
Automated API Documentation for Seamless Integration
As part of our commitment to enhancing the developer experience and streamlining the integration process for customers, we developed an Automated API documentation workflow.
Interactive API Documentation is now available in the Jellyfish Portal.
The documentation is always up to date with the version of Jellyfish that is deployed in that environment.
This means you can be sure, that what you see, is what you get.
Key Features:
- OpenAPI Compliant: We now automatically generate OpenAPI-compliant JSON documentation. This means that our API documentation is always up to date with the latest changes currently deployed in that environment, minimizing the risk of errors from outdated or incomplete documentation.
- Effortless Integration: Developers can now access clear, interactive API documentation that is immediately available through the Jellyfish Portal. This allows our customers to interact with the APIs directly, without the need for us to manually write and maintain documentation.
- Streamlined Developer Workflow: Automatically generated documentation removes the burden of keeping API specs in sync with services. Developers can focus on building integrations, rather than requesting updated documentation. With the instant availability of up-to-date API docs, teams can save valuable time.
- Enhanced Collaboration: With comprehensive and interactive API documentation available to customers, external partners, and internal teams, collaboration has never been easier. Detailed API specs enable seamless communication, faster issue resolution, and faster API adoption.
To access the API documentation for a specific environment, simply login to that jellyfish instance and click the Documentation link in the navigation bar.
Figure 1 – Link to documentation in the Jellyfish Portal
This will open a new page, containing a list of services and their related API documentation.
Figure 2 – The API Documentation page for a specific service
Download our Jellyfish Automated API Documentation Fact Sheet below
