Top 7 TypeScript api-documentation Projects

redoc

35 22,462 7.5 TypeScript

📘 OpenAPI/Swagger-generated API Reference Documentation

Project mention: Best Software Documentation Tools | dev.to | 2024-02-05

ReDoc Interactive Demo

graphql-voyager

10 7,613 7.5 TypeScript

🛰️ Represent any GraphQL API as an interactive graph
SurveyJS

surveyjs.io sponsored

Open-Source JSON Form Builder to Create Dynamic Forms Right in Your App. With SurveyJS form UI libraries, you can build and style forms in a fully-integrated drag & drop form builder, render them in your JS app, and store form submission data in any backend, inc. PHP, ASP.NET Core, and Node.js.
elements

6 1,496 8.8 TypeScript

Build beautiful, interactive API Docs with embeddable React or Web Components, powered by OpenAPI and Markdown. (by stoplightio)

Project mention: Scalar: An open-source alternative to Redocly and Swagger UI | news.ycombinator.com | 2023-10-13

Looks like a similar solution to https://github.com/stoplightio/elements - will give this a whirl some time!

Optic

12 1,280 9.8 TypeScript

OpenAPI linting, diffing and testing. Optic helps prevent breaking changes, publish accurate documentation and improve the design of your APIs.

Project mention: Show HN: LintGPT – Write API Style Guides in Natural Language | news.ycombinator.com | 2023-10-25

- Minimizing API calls. The first time you run LintGPT it is pretty slow because it has to run every rule across every part of the API specification (1000s of calls). But we shouldn’t have to repeat that work. Most of the time parameters, properties, etc don’t change and neither do the rules. We’re building caching into our web app to make this fast / save $ for end users.
Happy to answer any questions. I really think there’s a huge use case here for linting all kinds of code, config, database schemas, policies in ways that were never possible before. And personally, I like the idea of having these smart tools guiding me towards making my work better vs generating it all for me — idk something about that just feels good.
[0] https://github.com/opticdev/optic

docusaurus-openapi

3 472 6.5 TypeScript

🦕 OpenAPI plugin for generating API reference docs in Docusaurus v2.

Project mention: Scalar: An open-source alternative to Redocly and Swagger UI | news.ycombinator.com | 2023-10-13

I like your project. Glad to see alternatives to this https://docusaurus-openapi.netlify.app/

avantation

1 79 0.0 TypeScript

Build OpenAPI3.0 specification from HAR.
github-action

6 38 6.6 TypeScript

GitHub action to deploy your API documentation on Bump (by bump-sh)

Project mention: An AsyncAPI Example: Building Your First Event-driven API | dev.to | 2023-09-19

Let’s walk through the process of implementing an event-driven API using AsyncAPI, a specification for defining asynchronous APIs. We’ll also introduce Bump.sh, a tool for documenting and tracking event-driven APIs lifecycle/changes, and demonstrate how you can use it in conjunction with AsyncAPI files.

WorkOS

workos.com sponsored

The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.

NOTE: The open source projects on this list are ordered by number of github stars. The number of mentions indicates repo mentiontions in the last 12 Months or since we started tracking (Dec 2020).