shopstic / gitlab-rest-api-description

OpenAPI/Swagger description for GitLab's REST API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

GitLab REST API description

OpenAPI/Swagger description for GitLab REST API

Inspired by GitHub's official REST API descption
I wanted to make GitLab API more accessible.

This project currently offers OpenAPI 3.0 descriptions.
So it might be incompatible with some tools.

Goal

All OpenAPI descriptions in this project were initially generated
by crawling GitLab's API documentation using this project

As crawling web pages will never get to 100% accuracy, let alone the coverage.
These descriptions need lots of contribution to perfect.
Contributing guidelines coming soon.

Also, GitLab doesn't have any official API client.
These API descriptions play important role as they can be used to generate clients in different languages.

What is OpenAPI/Swagger description?

You can read OpenAPI Specification README
or if you are a hardcore reader, you may find RFC interesting.

About

OpenAPI/Swagger description for GitLab's REST API

License:MIT License