API Style Guides

GitLab API Style Guide

GitLab's developer-facing API style guide for the REST API (v4) and GraphQL API. Mandates Grape DSL parameter validation, Entity-based response payloads, Title Case summary verbs aligned to HTTP method, deprecation markers with migration guidance, and PATCH vs. PUT semantics. CC BY-SA 4.0.

GitHub

Other Resources

🔗
StyleGuide
https://docs.gitlab.com/ee/development/api_styleguide.html
🔗
GraphQLStyleGuide
https://docs.gitlab.com/ee/development/api_graphql_styleguide.html
🔗
License
https://creativecommons.org/licenses/by-sa/4.0/
🔗
Scope

API entry from apis.yml

apis.yml Raw ↑ 
aid: style-guides:gitlab
name: GitLab API Style Guide
description: GitLab's developer-facing API style guide for the REST API (v4) and GraphQL API. Mandates
  Grape DSL parameter validation, Entity-based response payloads, Title Case summary verbs aligned to
  HTTP method, deprecation markers with migration guidance, and PATCH vs. PUT semantics. CC BY-SA 4.0.
humanURL: https://docs.gitlab.com/ee/development/api_styleguide.html
baseURL: https://gitlab.com/api/v4/
tags:
- REST
- GraphQL
- GitLab
- Grape
properties:
- type: StyleGuide
  url: https://docs.gitlab.com/ee/development/api_styleguide.html
- type: GraphQLStyleGuide
  url: https://docs.gitlab.com/ee/development/api_graphql_styleguide.html
- type: License
  url: https://creativecommons.org/licenses/by-sa/4.0/
- type: Scope
  data:
    surfaces:
    - REST
    - GraphQL
    publisher: GitLab
    license: CC BY-SA 4.0
    status: living