Case study: Set up an API documentation set
Guidance for developers on setting up APIs in the Hub — covering repos, config, secrets, monitoring, alerting, and readiness. Built in VS Code, peer-reviewed in GitHub and written in Markdown.
Problem
Onboarding steps were fragmented across tools and hard to scan.
What I did
Created a documentation set of task-based guidance pages to help developers set up APIs for microservices.
Impact
Clear ‘what to do next,’ fewer Slack questions, and consistent patterns across the documentation set.
Browse by category
Jump straight to guidance grouped by lifecycle stage.
🏁Getting started
- Prepare to build a Developer Hub APIWhat to know before you begin
- Create a GitHub repository
⚙️Configuration & security
🔌Integration & service management
📊Monitoring & observability
🚨Alerting & incident response
✅Readiness & compliance
Set up an API documentation set
This guidance is for teams setting up a Developer Hub API microservice. Follow the sections below to configure everything from repositories to monitoring and alerting.
Preparation
Prepare to build a Developer Hub API
Get ready with the tools and information you need before building an API.
Repository & Configuration
Create a GitHub repository
Set up a new GitHub repo for your microservice codebase.
Create app configuration
Define environment configuration settings for your API.
Create and manage application secrets
Manage secure credentials and API keys used by your service.
Service Management
Add a microservice to Service Manager
Register your microservice with Service Manager for deployment.
Observability
Add a logs dashboard to Kibana
View logs and troubleshoot API behaviour using Kibana.
Add a metrics dashboard to Grafana
Track service health and performance with Grafana dashboards.
Alerting
Add service alerting using PagerDuty
Configure incident alerts and escalation policies with PagerDuty.
Readiness
Create a platform readiness assessment (PRA) page
Ensure your API meets readiness criteria before going live.
Need support?
If you have any problems, contact the MDTP Docs team on Slack.