# Swagger-Editor

Swagger-Editor is a self-hosted, browser-based editor for OpenAPI API definitions, supporting OpenAPI 2.0 and OpenAPI 3.0.3 in JSON or YAML. It is open source and self-hosted, installable on Docker Hub and Unraid.

Canonical page: https://ourlocalhost.com/app/484/swagger-editor

## Description

Swagger Editor is a self-hosted, browser-based editor for OpenAPI API definitions, supporting OpenAPI 2.0 and OpenAPI 3.0.3 in JSON or YAML. It validates your specification as you type and previews the rendered documentation in real time, producing a valid definition ready for the rest of the Swagger toolchain such as code generation and API documentation. It suits developers and API teams who want a private place to author, refine, and share API specs.

## Platform availability

Available on 1 of 9 platforms: Unraid.

## Health score

81/100 (Excellent), based on 3 of 4 factors.
- Maintained: 100 (last commit 14 days ago)
- Popular: 89 (29,029 GitHub stars)
- Easy to install: 35 (1 install platform, install notes, Docker image)

## Links

- Docker Hub: https://hub.docker.com/r/swaggerapi/swagger-editor
- Unraid: https://ca.unraid.net/apps/swagger-editor-0dhqvzq1tfo6h6?q=Swagger-Editor
- Official website: https://editor.swagger.io/
- GitHub: https://github.com/swagger-api/swagger-ui

## Common questions

### Will the Swagger Editor web app run with JavaScript disabled?

No, the web page says you need to enable JavaScript to run the app.

### Can the Swagger Editor npm package be used with older React versions?

The Swagger docs give an example of using swagger-editor@5 with React 17.0.2.

### What licensing details are given for the OpenAPI specification?

The OpenAPI specification is described as being under a permissive license. The same source says the author does not believe all Swagger-produced services or software is open source.

## Alternatives

- Doxygen: Doxygen is a tool for generating documentation from annotated C++ sources, as well as other popular programming languages like C, Objective…

---
Source: Our Local Host (https://ourlocalhost.com/app/484/swagger-editor), the self-hosted and open-source app directory.