OpenAPI
OpenAPI is a self-hosted tool for reading, testing, and organising OpenAPI specifications, the standard that describes how HTTP APIs work.
Platform availability
Available on 0 of 10 platforms
- Unraid (not listed)
- TrueNAS (not listed)
- Umbrel (not listed)
- ZimaOS (not listed)
- Proxmox (not listed)
- Helm (not listed)
- Mac (not listed)
- Windows (not listed)
- Linux (not listed)
- Any server (not listed)
Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.
70/100 Good
- Maintained
- 100last commit 34 days ago
- Popular
- 9031,295 GitHub stars
- Easy to install
- 250 install platforms, install notes, Docker image
- Light to run
- 801 GB minimum RAM, runs on ARM
- Security check
- 201 serious finding, CI, tests, OpenSSF Scorecard 4.2/10
Security check: 1 serious finding
- A GitHub workflow can be triggered by outsiders to run their code with the project's secrets (.github/workflows)
Automated checks on commit ffb3e57, 12 Oct 2026. Not an audit.
- GitHub stars
- 31,295
- Open issues
- 84
- Last commit
- 2026-10-18
- Latest release
- 3.2.1
- License
- Apache-2.0
- Activity
- declining
Checked 18 days ago - source: GitHub (OAI/OpenAPI-Specification)
Resources & Compatibility
Minimum requirements: 1 GB RAM, 1 CPU core(s). ARM (e.g. Raspberry Pi) is supported.
Checked 54 days ago - source: Docker Hub image tags and published docs
First-install notes
- Install the required npm packages Run `npm i openapi-react-query openapi-fetch` and `npm i -D openapi-typescript typescript` to add the OpenAPI client, request helper, and type generator to your project. Without them, the OpenAPI imports and React Query hooks won't work. source
- Point the client at your API Create the fetch client with the generated TypeScript types from your OpenAPI schema (the file that describes your API) and set `baseUrl` to your API's real address. If `baseUrl` is missing or wrong, requests go to the wrong place and fail at runtime. source
- Use Node.js 20 or newer Before running the setup commands, make sure Node.js 20.x or higher is installed. If you use an older Node.js version, the OpenAPI/TypeScript tooling may fail to install or build. source
Fetched 53 days ago - each note links to its source
Variants
Alternatives
No alternatives collected yet.
Common questions
Does the self-hosted community edition documentation provide a compose file?
Yes. The self-hosting documentation includes a compose file that brings the whole platform up on your own infrastructure.
Can OpenAPI documentation be generated as shareable HTML pages?
Yes. Redoc can generate nicely formed HTML pages from an OpenAPI or Swagger specification to share with others.
What practical OpenAPI specification areas should engineers review?
The practical FAQ addresses versioning, JSON Schema alignment, structure, errors, and common pitfalls.
Which advanced OpenAPI features might some generators not handle?
The reported generator experience included failures with oneof, anyof, multiple requests, multiple responses, multiple response codes, multipart data, components, and features beyond basic examples.
Answers sourced from openapi.ai, www.appear.sh, www.reddit.com, www.reddit.com
Community
- Self-hosted alternative to OpenAI Assistants API : r/selfhosted - Reddit (reddit)
- How do you write your API documentation? Any self-hosted ... - Reddit (reddit)
Collected 48 days ago - public community threads