Scalar

Scalar is a platform for building API documentation that looks professional and works smoothly. You provide your OpenAPI document, and Scalar transforms it into easy-to-read pages with examples and testing tools built in.

The platform offers several products working together. The API Reference shows your documentation in a clean layout. The API Client lets developers test endpoints directly. The platform also includes tools for managing multiple versions of your API documents and syncing with GitHub.

Scalar is completely open-source, which means the code is public and free to use. You can host it yourself or use their cloud service. The free plan covers basic features, while paid plans add collaboration tools, custom domains, and better support.

Using Scalar is simple and does not require complex setup. Here are the steps to get started:

• Visit the Scalar website and create a free account to save your work. You will get a free subdomain like yourname.apidocumentation.com.

• Upload your OpenAPI document by pasting a URL, uploading a file, or connecting to GitHub. Scalar supports both JSON and YAML formats.

• Choose a theme and customize the colors to match your brand. You can add custom CSS if you want more control over the design.

• Write additional guides using the editor. These pages explain concepts that go beyond the automatic reference pages.

• Test your API endpoints using the built-in client. Click on any endpoint, add parameters, and send requests to see real responses.

• Share your documentation with your team or make it public. You can set permissions to control who can edit or view.

• Beautiful API documentation from OpenAPI files

• Built-in testing with API client

• GitHub integration and auto-sync

• Custom domains and themes

• Framework integrations for all major platforms

• TypeSense-powered search

• Multiple API versions support

• Markdown and MDX guides

• Team collaboration tools

• Open-source and self-hostable

• Free subdomain included

• Custom CSS and JavaScript support