GitLab Well Architected
Cookbook navigation
Prompts / Design API Endpoints

Design API Endpoints

Planning & ArchitectureAPIApiArchitectArchitectureDesignPlanIntermediate

Define RESTful or GraphQL APIs with proper contracts, authentication, and error handling.

For GitLab Duo

prompt

Design API endpoints for:

[FEATURE DESCRIPTION]

Define:
1. Endpoint paths and methods
2. Request/response schemas
3. Authentication requirements
4. Error responses
5. Rate limiting needs

Use the prompt

Describe the callers and the actions they need to perform. Existing API conventions and examples help the proposed endpoints fit the rest of your application.