Case study: set up an API documentation set
Guidance for developers on setting up APIs in the Hub. It covers repositories, configuration, secrets, monitoring, 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 task based guidance pages to help developers set up APIs for microservices.
Impact
Clear next steps, 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 and security
🔌Integration and service management
📊Monitoring and observability
✅Readiness and compliance
Set up an API documentation set
This guidance is for teams that set up a Developer Hub API microservice. Follow the sections below to configure everything from repositories to monitoring and readiness.
Preparation
Prepare to build a Developer Hub API
Get the tools and information you need before you build an API.
Repository and configuration
Create a GitHub repository
Set up a new GitHub repository 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 for 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 in Kibana.
Add a metrics dashboard to Grafana
Track service health and performance with Grafana dashboards.
Readiness
Create a platform readiness assessment (PRA) page
Make sure your API meets readiness criteria before it goes live.
Need support?
If you have any problems, contact the MDTP Docs team on Slack.