ApiNotes
apinotes.io
- Free plan
- Web
What ApiNotes is
ApiNotes turns OpenAPI and Swagger specifications into hosted interactive documentation and an automatically generated changelog that alerts users to breaking changes. It supports OpenAPI 3.0, 3.1 and 3.2, along with Swagger 2.0, in YAML or JSON. Generated references show endpoint parameters, response schemas and code examples in more than 10 programming languages, with a built-in Try-It-Now console. Users can paste, upload or link a specification and publish docs to an ApiNotes subdomain. A GitHub Action can publish a revised specification when changes are merged; the Team plan also lists pull request comments about breaking changes. The free Starter plan supports one public API and retains the last 10 changelog releases. Team costs $19 a month and includes five APIs, private docs, full changelog history, unlimited subscribers and a custom domain. Additional APIs are listed at £5/API. The Team plan includes a 14-day free trial with no credit card required. Postman, Bruno and Insomnia integrations are marked as coming soon.
Who it suits
ApiNotes suits developers or teams publishing API references from OpenAPI or Swagger files. It is relevant to teams that want changelog alerts or a GitHub-based publishing workflow.
Good to know, and what to watch
- Supports OpenAPI 3.0, 3.1, 3.2 and Swagger 2.0
- Generates interactive references with a Try-It-Now console
- GitHub Action can publish updates on merge
- Free plan supports one public API
- Starter retains only the last 10 changelog releases
- Starter supports public APIs only
- Postman, Bruno and Insomnia integrations are coming soon
Plans
Every plan and priceStarter
Team
Free plan · 14-day trial
Getting started
- Open the ApiNotes website
- Choose the free Starter plan or begin the Team trial
- Paste, upload, or link an OpenAPI or Swagger specification
- Publish the generated documentation to an ApiNotes subdomain
- Connect the GitHub Action if you want publishing on merge
Limits to check
Starter is limited to one public API, the last 10 changelog releases, 25 subscribers, and one team member. Team includes five APIs; additional APIs are listed at £5/API.
The Club's review
Overview
ApiNotes is a hosted service that turns API specifications into interactive documentation and tracks changes between versions. It suits developers and teams who already maintain OpenAPI or Swagger files and want a published reference with breaking-change alerts. Its strongest case is a GitHub-based workflow for a handful of APIs; teams needing private docs or a longer changelog must pay.
Key features
ApiNotes supports OpenAPI 3.0, 3.1, 3.2 and Swagger 2.0 in YAML or JSON. Generated references include endpoint parameters, response schemas, examples in more than 10 programming languages and a Try-It-Now console. That gives API consumers reference material and a way to try endpoints within the docs, without requiring a separate documentation authoring step.
Users can paste, upload or link a specification and publish it on an ApiNotes subdomain in under 60 seconds. A GitHub Action can publish updates when changes are merged, while Team adds pull-request comments that flag breaking changes. This is a focused fit for teams whose specification and review process already runs through GitHub. Postman, Bruno and Insomnia integrations are marked as coming soon.
The generated changelog highlights breaking changes. Starter keeps the last 10 releases, which may be enough for a small public API but limits its usefulness as a lasting change record. Team includes full history. Starter also provides unlimited validator and diff tools, though its single API and single team member restrict collaboration and scale.
ApiNotes hosts uploaded specifications for documentation and versioning. Users retain intellectual property rights to their specifications, code and generated documentation. Staff do not manually review stored specifications unless a user requests support troubleshooting. If users choose AI fixing tools, relevant portions are sent to OpenAI for formatting corrections and are not used to train public models. Deleting an account removes personal data and projects from production databases within 30 days; encrypted backups may retain residual data for up to 90 days.
Pricing
ApiNotes is freemium, with a 14-day Team trial that does not require a credit card.
- Starter: free. It includes one public API, the last 10 changelog releases, up to 25 subscribers, one team member, and unlimited validator and diff tools. It is a sensible starting point for an individual or small team publishing one public API, but there is no private documentation or full history.
- Team: $19 a month. It includes five APIs, full changelog history, unlimited subscribers, private docs, 25 guest readers, a custom domain and five team members. It fits a small team that needs private access or a more complete record of API changes. Additional APIs are listed at £5/API; custom plans are available by contacting ApiNotes.
The paid plan's five-API allowance and five team members give a small team room to work, while the Starter caps make the free tier less suitable as an organization grows or needs private docs. The service names AWS or DigitalOcean for hosting, MongoDB Atlas for its database, Lemon Squeezy for payments and OpenAI for AI processing.
Platforms
ApiNotes is web-based and hosted, with generated documentation published on an ApiNotes subdomain or, on Team, a custom domain.
Who it's for
ApiNotes is a good fit for developers and small teams who maintain OpenAPI or Swagger specifications, publish API references from them and want automated change tracking. It is less suitable for teams that need offline or self-hosted documentation, rely on Postman, Bruno or Insomnia imports today, or need more than five APIs without an additional charge.
Pros and cons
- Pros: Supports four OpenAPI and Swagger specification versions in YAML or JSON, with interactive references, examples in more than 10 languages and a built-in console.
- Pros: GitHub publishing on merge and Team pull-request comments connect documentation updates with the development workflow.
- Pros: Starter includes unlimited validator and diff tools, and Team combines private docs with full changelog history.
- Cons: Starter is limited to one public API, one team member and 10 changelog releases, constraining collaboration and history on the free plan.
- Cons: Postman, Bruno and Insomnia integrations are not yet available, limiting import options for teams using those tools.
Alternatives
API Documentation Tools is a useful place to compare options across the category. PilotDocs may suit readers considering a freemium web alternative with Starter at $49 a month, 10 projects, unlimited API endpoints and unlimited guides and tutorials; that higher starting price makes ApiNotes' free single-API plan the more accessible entry point.
Scalar is worth considering for readers who want a free plan covering up to three APIs, one editor seat and a broader choice of platforms, including self-hosted and desktop options. Fern may appeal to teams whose priorities include a free allowance of 10 team members, one site and up to 1,000 pages. Javadoc is an option for readers working with Java documentation through JDK 25. Swagger Codegen is an open-source choice for generating API clients, server stubs and documentation from OpenAPI specifications. Doxygen is free, open-source software for readers who want documentation tooling on Windows, Linux or macOS.
Palt offers a free web plan with three projects, a custom domain, a Try It playground and basic analytics; its Pro plan is $19 a month per project. That may fit readers who want a free multi-project starting point and a custom domain. phpDocumentor is a free, open-source PHP documentation tool for Linux, macOS and self-hosted setups.
Verdict
Choose ApiNotes if you maintain OpenAPI or Swagger files and want hosted interactive docs with a changelog tied to specification updates, particularly if your team uses GitHub. The free plan is a practical way to publish one public API, but private docs, expanded team access and full history start with Team at $19 a month. Look elsewhere if you need self-hosting, imports from Postman, Bruno or Insomnia now, or a broader free allowance for APIs and collaborators.
The verdict
ApiNotes combines hosted API documentation with version-change tracking. The free tier is limited to one public API, while Team adds private docs and expanded changelog history.
Questions people ask
What specifications does ApiNotes support?
It lists full support for OpenAPI 3.0, 3.1, and 3.2, and Swagger 2.0 in YAML or JSON.
Is there a free plan?
Yes. Starter costs nothing and includes one public API, 10 changelog releases, up to 25 subscribers, and one team member.
How much does Team cost?
Team costs $19 a month. It includes five APIs, private documentation, full changelog history, unlimited subscribers, a custom domain, and five team members.
Can ApiNotes publish from GitHub?
A GitHub Action can publish an updated specification on merge. Team also lists pull-request comments showing breaking changes.
Who owns uploaded specifications and generated documentation?
Users retain full intellectual property rights to uploaded specifications, code, and generated documentation.
What the maker publishes
- AI processing
- If users use the AI fixing tools, relevant specification portions are sent to OpenAI for formatting corrections and are not used to train public models. source
- Data deletion
- After account deletion, personal data and uploaded projects are deleted from production databases within 30 days, while encrypted backups may retain residual data for up to 90 days. source
- Data ownership
- The privacy policy says users retain full intellectual property rights to uploaded specifications, code, and generated documentation. source
- GitHub integration
- A GitHub Action can publish an updated specification on merge, and the Team plan lists PR comments showing breaking changes. source
- Interactive docs
- Generated docs include endpoint parameters, response schemas, code examples in 10+ programming languages, and a built-in Try-It-Now console. source
- Other import integrations
- Postman, Bruno, and Insomnia integrations are marked “Coming soon.” source
- Pricing limits
- Starter is limited to one public API and the last 10 changelog releases; Team includes five APIs, with additional APIs listed at £5/API. source
- Publishing workflow
- Users can paste, upload, or link a specification and publish documentation at an ApiNotes subdomain in under 60 seconds. source
- Service providers
- The privacy policy names AWS or DigitalOcean for hosting, Lemon Squeezy for payments, MongoDB Atlas for the database, and OpenAI for AI processing. source
- Specification access
- Uploaded specifications are stored for documentation hosting and versioning, and the policy says staff do not manually review them unless support troubleshooting is requested. source
- Support and custom plans
- The pricing page invites users who need a custom plan to contact ApiNotes. source
- Supported specifications
- The site lists full support for OpenAPI 3.0, 3.1, 3.2, and Swagger 2.0 specifications in YAML or JSON. source
- Team plan trial
- The Team plan includes a 14-day free trial and says no credit card is needed. source
- What it does
- ApiNotes turns OpenAPI or Swagger specifications into hosted interactive documentation and an automatically generated changelog with breaking-change alerts. source
Checked against the maker's pages on 30 Sept 2026.