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
🔗
GraphQL
https://raw.githubusercontent.com/api-evangelist/style-guides/refs/heads/main/graphql/style-guides-graphql.md

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitlab"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

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
- url: graphql/style-guides-graphql.md
  type: GraphQL