Skip to content

Application

ReadMe Micro

Struggling to keep track of your team's internal APIs? Say hello to ReadMe Micro, the auto-generated documentation solution for internal APIs 👋

Connect ReadMe Micro to your GitHub org, select the repos with OAS files you want to include, and we'll auto-generate an API Reference for it 🚀

Think of it as a developer hub for your engineering team — a centralized place to discover, organize, and share all of your company's internal APIs 📌

Organize and Auto-Generate Docs for Your Internal APIs ⏭️

For each connected repo, ReadMe automatically creates an API Reference, including auto-generated code samples. We support multiple OAS files per repo, too 😉

Always Synced, Always Documented 📰

Any changes made to the synced OAS files are auto-synced in ReadMe Micro. Plus, all changes are noted in an auto-generated changelog and shown as differentiated versions, allowing users to easily scan all recent updates

Add More Info 📕

Want to give more deets? Upload Markdown files to include more instructions and helpful tips for each synced repo. Plus, add topics to repositories for easier searching!

Sharing is Caring 🤗

Once your repos are synced in ReadMe Micro, engineering teams across your company can use ReadMe Micro to find, search for, and bookmark internal APIs. Now teams have all of the info they need to start using your APIs quickly, and don't have to worry about manually updating files!

Sync an unlimited number of repos per org and bookmark APIs for easy reference

Pricing and setup

ReadMe Micro logo preview
ReadMe Micro

Pro - Free Trial

Try out ReadMe Micro for free for 30 days! $10/user/month after that.

For organizations only

  • Connect your org and start syncing your repos
  • Invite other users in your org to try out ReadMe Micro
  • An OAS file is required to sync your repo
  • Internal or microservice APIs have to be REST-based

Next: Confirm your installation location.

ReadMe Micro is provided by a third-party and is governed by separate terms of service, privacy policy, and support documentation.