Automatically Generating OpenAPI Docs for Mastodon

• Mastodon

  1,226 45,967 10.0 Ruby

  Your self-hosted, globally interconnected microblogging community

  

As the Mastodon open source community grows, many developers are coming into the project for the first time and learning more by viewing the documentation. One of the common pieces of documentation that users in both the Mastodon Discourse and GitHub issues are looking for is an up-to-date version of API documentation.

• Newman

  245 6,719 7.5 JavaScript

  Newman is a command-line collection runner for Postman

  

Now that AppMaps exist with our API requests, you can generate the OpenAPI v3 supported specification file via either VS Code or using the AppMap CLI. From there you can import this into Postman, other API management tools, or share with your team.

• SurveyJS

  surveyjs.io featured

  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.

  

• AppMap

  4 63 5.5

  AppMap is the ultimate code reviewer for issues that static analysis and AI code assistants cannot find.

  

By now you’ll now have AppMaps recorded from the Mastodon tests. The AppMap data specification includes all of the API calls processed including the schema of each request and response. Using the AppMap CLI (or the VS Code or JetBrains extension) developers can automatically output OpenAPI specifications for Mastodon in just 3 steps.

• appmap-js

  4 44 9.9 TypeScript

  Client libraries for AppMap

  

The AppMap CLI is written in JavaScript which makes it easy to run across a variety of platforms. You’ll need Node.js installed or alternatively you can grab pre-built binaries for @appland/appmap on Github.

Suggest a related project