API Style Guides · GraphQL Specification

API Style Guides GraphQL API

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.

Documentation Endpoint View on GitHub API Style GuidesAPI DesignAPI GovernanceRESTOpenAPIConventionsStandardsDocumentationGraphQL

Overview

API Style Guides GraphQL API is a GraphQL API specification published by API Style Guides on the APIs.io network.

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.

The GraphQL endpoint is available at https://gitlab.com/api/v4/. documentation is published at https://docs.gitlab.com/ee/development/api_styleguide.html.

The specification includes 1 reference link.

Tagged areas include API Style Guides, API Design, API Governance, REST, and OpenAPI.

Endpoint

https://gitlab.com/api/v4/

References

GraphQLStyleGuide https://docs.gitlab.com/ee/development/api_graphql_styleguide.html

Back to API Style Guides · All GraphQL Specs · GitHub