here's the OpenAPI v4 description available in their git repo.

https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi.yaml?plain=1

Answer from Jeremy Fiel on Stack Overflow
🌐
Stack Overflow
stackoverflow.com › questions › 78257142 › where-to-find-gitlab-api-v4-swagger-openapi-specification
Where to Find GitLab API v4 Swagger/OpenAPI Specification? - Stack Overflow
Top answer
1 of 1
4

here's the OpenAPI v4 description available in their git repo.

https://gitlab.com/gitlab-org/gitlab/-/blob/master/doc/api/openapi/openapi.yaml?plain=1

How to access the GitLab API?
swagger - How to integrate openapi specifications from different APIs?
swagger - Can GitLab's rendered openapi.yaml make API calls?
How to use OpenAPI / Swagger by authenticating endpoints?
swagger - How can I find companies OpenAPI specifications?
More results from stackoverflow.com
🌐
GitLab
forum.gitlab.com › how to use gitlab
Is there a GitLab API Specification, such as Swagger or RAML? - How to Use GitLab - GitLab Forum
June 11, 2015 - I’m the author of the GitLab::API::v3 Perl module and came up with my own very limited specification of the GitLab API here: I’d like to change this to use an official API specification, optimally Swagger. I was abou…
🌐
Reddit
reddit.com › r/gitlab › gitlab openapi spec sheet/swagger
r/gitlab on Reddit: Gitlab OpenAPI spec sheet/swagger
December 23, 2024 -

I know this may be a dumb question, but is there any chance gitlab has its OpenAPI/swagger json built into gitlab itself? I.E. on an offline instance I can go to something like https://gitlab.example.com/api/v4/swagger.json? I l am trying it pull the API definitions for our suite of applications for security purposes.

I had found the online version and yeah sure I could pull the spec from gitlab.com, but getting that file moved to the offline environment where it is needed is... troublesome. I'm also not going to hand transcribe it because I'm an engineer not a data entry clerk.

Top answer
1 of 3
2
It's incomplete, so may not be suitable for your purpose https://gitlab.com/groups/gitlab-org/-/epics/8926
2 of 3
1
Honest question, why would you want a swagger file while oas has been around since 2016, oas 3 since 2017 I do find the gitlab api to be rather a maze, I agree a decent openapi spec would be useful. I haven't checked for it's existence but I have to say I'm not surprised it's not there. Gitlab api is sort of a... idk, not an api first api
🌐
GitLab
gitlab.com › gitlab.org › gitlab foss › repository
doc/api · swagger-api · GitLab.org / GitLab FOSS · GitLab
GitLab FOSS is a read-only mirror of GitLab, with all proprietary code removed. This project was previously used to host GitLab Community Edition, but all development...
🌐
Medium
medium.com › hoursofoperation › auto-generate-swagger-docs-to-gitlab-pages-ca040230df3a
Auto-generate Swagger docs to Gitlab Pages | by Aron Budinszky | hoursofoperation | Medium
November 19, 2019 - Auto-generate Swagger docs to Gitlab Pages After you created your OpenAPI specs, you can automatically generate and publish your API documentation to Gitlab Pages using Gitlab shared runners. Add …
🌐
GitLab
gitlab.com › gitlab.org › gitlab foss › merge requests › !2397
WIP: Expose Swagger API (!2397) · Merge requests · GitLab.org / GitLab FOSS · GitLab
This MR adds a Swagger API endpoint with API viewer for easy API access. Closes https://gitlab.com/gitlab-org/gitlab-ce/issues/4308
🌐
Medium
medium.com › haven-life › keeping-swagger-documentation-in-sync-with-swaggerhub-api-the-gitlab-pipeline-f8ae726a9802
Keeping Swagger documentation in sync with SwaggerHub API & the GitLab pipeline | by Rita Kaufman | Haven Technologies’ Developer & Technology Blog | Medium
April 20, 2022 - For example, we use SwaggerHub to host documentation for the API that communicates between our system that life insurance agents use to enter customer information, and the internal applications that host the products that need information from the agents. These Swagger (or, OpenAPI) documentation files use YAML format and live in our repositories on GitLab.
🌐
SmartBear
support.smartbear.com › swaggerhub › docs › en › integrations › gitlab-sync.html
GitLab Sync | SwaggerHub Documentation
You can use the GitLab integration settings to synchronize your API definition, auto-generated server code, or client SDK with an existing repository on GitLab. The synchronization is made every time you save the API in Swagger Studio.
Find elsewhere
🌐
GitLab
docs.gitlab.com › gitlab docs › extend › rest api › openapi
OpenAPI | GitLab Docs
GitLab documents its REST API using the OpenAPI 3.0 specification (formerly called Swagger), a standard, platform-independent format for describing RESTful APIs. The API code is the single source of truth for the REST API.
🌐
StackShare
stackshare.io › stackups › gitlab-pages-vs-swagger-ui
Swagger UI vs GitLab Pages | What are the differences? | StackShare
Swagger UI - Swagger UI is a dependency-free collection of HTML, Javascript, and CSS assets that dynamically generate beautiful documentation and sandbox from a Swagger-compliant API GitLab Pages - Host your static websites on GitLab.com for ...
🌐
Stack Overflow
stackoverflow.com › questions › 65482842 › swagger-api-documentation-with-my-own-yaml-file
swagger API documentation with my own yaml file - Stack Overflow
Top answer
1 of 1
2

If for some reason you cannot host Swagger UI youself, here are some alternatives you can try:

  • Use SwaggerHub to host your API definition and docs.
    Disclosure: I work for the company that makes SwaggerHub.

  • Use GitLab to host your OpenAPI YAML/JSON file. GitLab uses Swagger UI to render OpenAPI files. Example:
    https://gitlab.com/gofus/gofus-api/blob/dev/swagger.yaml

  • Use https://petstore.swagger.io with the url query parameter to automatically load your API definition:

    https://petstore.swagger.io?url=https://yoursite.com/api.yaml

    For this to work, the server where your OpenAPI file is hosted must use HTTPS and support CORS.

🌐
GitLab
gitlab.com › mdhtr › gitlab-pages-swagger-ui
mdhtr / gitlab-pages-swagger-ui · GitLab
Example Swagger UI gitlab page. View resulting page at: https://mdhtr.gitlab.io/gitlab-pages-swagger-ui/
🌐
GitHub
gist.github.com › mtvbrianking › 57faef18645e1e7f69c59ac18423610c
Gitlab pages deploy swagger docs · GitHub
This file renders the swagger.json file that resides here: https://petstore.swagger.io/v2/swagger.json "sed -t" looks for the line which contains the path to swagger.json file and replaces it with "your" json file, so that it renders your custom json with the same formatting.
🌐
GitLab
gitlab.com › gitlab.org › #16023
Use the OpenAPI specification for the API docs (#16023) · Issues · GitLab.org / GitLab · GitLab
September 27, 2016 - The result is https://axil.gitlab.io/swaggerapi/, but it takes ages to load. That was the best interface I could find that would easily convert our openapi json export in readable API docs. A drawback is that is generates non-friendly URLs like https://axil.gitlab.io/swaggerapi/#operation/putV3GroupsId.
🌐
npm
npmjs.com › package › gitlab-swagger-client
gitlab-swagger-client - npm
July 14, 2016 - A fetch-based GitLab API client, auto-generated using Swagger codegen.. Latest version: 0.1.1, last published: 9 years ago. Start using gitlab-swagger-client in your project by running `npm i gitlab-swagger-client`. There are 0 other projects ...
      » npm install gitlab-swagger-client
Published: Jul 14, 2016
Version: 0.1.1
Author: Jay Anslow
Repository: https://gitlab.com/janslow/gitlab-swagger-client
Homepage: https://gitlab.com/janslow/gitlab-swagger-client
🌐
GitHub
github.com › go-gitea › gitea › issues › 20852
OpenAPI Viewer · Issue #20852 · go-gitea/gitea
August 18, 2022 - Feature Description GitLab has a feature where they can render openapi/swagger documents using swagger-ui in a rendered view. We should consider adding this too as we already bundle swagger-ui, so it's a almost-zero cost addition. GitLab...
Author: go-gitea
🌐
GitLab
gitlab.com › gitlab.org › #19515
Integrate with OpenAPI editor (#19515) · Issues · GitLab.org / GitLab · GitLab
Description OpenAPI aka. Swagger is a widely used API description format. The idea is to: render an...
🌐
Gitlab
api-0b8056.gitlab.io
Swagger API Docs
We cannot provide a description for this page right now
🌐
GitHub
github.com › buchenberg › swagger-editor-gitlab
GitHub - buchenberg/swagger-editor-gitlab: Swagger Editor with Gitlab support (work in progress)
git clone https://github.com/swagger-api/swagger-editor.git cd swagger-editor npm install npm start
Forked by 2 users
Languages: JavaScript 73.6% | HTML 14.4% | CSS 11.8% | Shell 0.2% | JavaScript 73.6% | HTML 14.4% | CSS 11.8% | Shell 0.2%