Create a Github repository (API)

Use the MDTP Catalogue to scaffold a new API microservice repository that follows platform conventions. This step ensures your code starts with the correct directory structure, routes, and documentation files.

Create a new repository

  1. Go to the create a service repository page in the MDTP Catalogue.
  2. Select Service as the repository type.
  3. In the form, choose one of these types:
    • API microservice
    • API microservice - with mongodb
  4. Select Build to generate the repository and kick off setup.

💡 Tip

Use the #team-api-platform-sup Slack channel to ask questions while filling the form.

What gets generated

Once built, the following files are scaffolded into your repository:

  • /app/DocumentationController.scala
  • /conf/definition.routes
  • /resources/definition.json
  • /resources/application.yaml
  • /resources/overview.md

These follow the expected layout for APIs built on the Developer Hub. You’ll edit these files to configure your endpoints and documentation later.

Verify your repository

  1. Go to the repositories dashboard in the MDTP Catalogue.
  2. Find and select your microservice.
  3. Under the Code section, choose Commissioning State to confirm creation.

🧪 Optional Git Check

To double-check locally, you can clone your new repo:

git clone https://github.com/hmrc/your-repo-name.git

Replace your-repo-name with the name you chose in the creation form.

Need support?

Ask questions in #team-api-platform-sup on Slack. You can also refer to the API development standards.

Got feedback?

We’re always improving our documentation. Share your suggestions in Slack or through a pull request.