GitLab Well Architected
Cookbook navigation
Prompts / Analyze API Contracts and Integrations

Analyze API Contracts and Integrations

Code UnderstandingAPIApiDeveloperDocumentationIntegrationCreateBeginner

Document how your system integrates with internal and external APIs. Prevents breaking changes in integrations.

For GitLab Duo

prompt

Show me how we integrate with [SERVICE/API]. What endpoints do we call and what data do we send/receive?

Use the prompt

Replace [SERVICE/API] with the service you're investigating and share the code that calls it with GitLab Duo Chat. Including the surrounding configuration and response handling helps Duo explain how your application uses the API, rather than just describe the API itself.