Prepare to build a Developer Hub API
Before building a Developer Hub API, you need to complete planning tasks and coordinate with platform teams. This ensures your API can be deployed, published, and integrated correctly from day one.
Understand platform standards
Before starting development, review the following:
- API naming conventions
- Versioning guidance
- API security requirements
- What makes an API "public"
- How API documentation is published
Create your API Approval Process page
The API Publishing team uses a shared Confluence template to assess all new APIs.
- Go to the API Publishing Process template.
- Copy the template to your team’s Confluence space.
- Make sure the parent page is named API Approval Process.
- Start working through the phases in the template.
Step 3: Engage with required teams
The following teams may need to contribute to your API approval process:
| Team | When to involve them |
|---|---|
| API Platform | Always — they're the owners of this process |
| Platform Security | If your API handles personal or sensitive data |
| Integration Team | If your API depends on existing internal APIs |
| Publishing Team | To register your API for external publication |
Complete Phase 3
Phase 3 in the Confluence template includes:
- Finalising your endpoint design
- Confirming authentication and authorisation decisions
- Listing upstream dependencies
- Documenting your error strategy
Once Phase 3 is complete, you’re ready to begin technical implementation.
What's next?
Start your build using the guide: Create a GitHub repository for your API.
Need support?
Ask in #team-api-platform-sup on Slack.
Got feedback?
We’re always improving our documentation. Share your feedback using the team channel above.