I'm building a developer portal for our API, what should I use?

It depends on what you want the portal to do, but for most API teams the best choice is one of these:

Best options by use case

1. If you want the fastest path to a polished developer portal

Use a hosted API portal platform:

• ReadMe
• Stoplight
• Backstage + API plugin(s) if you already use Backstage internally
• Scalar / Redocly for documentation-first portals

Good for: polished docs, API reference, auth guides, changelogs, onboarding, interactive “try it” consoles
Tradeoff: less flexibility than building everything yourself, recurring cost

---

2. If you want full control and can build it yourself

Use a custom portal with:

• Next.js or Nuxt
• OpenAPI/Swagger for API docs
• Redoc or Scalar for reference rendering
• MDX or Markdown for guides/tutorials
• Auth integration for API keys / OAuth app management
• Search via Algolia, Typesense, or Elastic

Good for: bespoke UX, tight product integration, custom onboarding, deep analytics
Tradeoff: more engineering time, maintenance, and content tooling work

---

3. If you’re already on a platform and want docs + internal tooling

Use Backstage if your portal is part of a broader developer experience platform.

Good for: internal/external dev portals, service catalog, API docs, ownership, templates
Tradeoff: more “platform” than “docs site,” so it can feel heavy if you only need docs

---

My practical recommendation

If you’re just starting out:

• Small team / need to ship quickly: ReadMe or Stoplight
• Docs-first, API reference heavy: Redocly or Scalar
• Need a custom branded experience or product integration: Next.js + OpenAPI + Redoc/Scalar
• Want a broader developer platform: Backstage

---

What a good portal usually includes

No matter the stack, aim for:

• API reference from OpenAPI
• Getting started guide
• Auth examples
• SDK examples
• Use-case tutorials
• Changelog / versioning
• Sandbox or “try it” console
• Search
• Clear error/help links
• API key / app registration flow if needed

---

If you want the simplest answer

For most teams: ReadMe if you want speed and polish, or Next.js + Redoc/Scalar if you want custom control.

If you tell me:

1. your API type (REST/GraphQL/gRPC),
2. whether the portal is public or private,
3. your preferred stack,
4. and whether you need API key management,

I can recommend a specific setup.