Skip to content
GitLab
Projects Groups Topics Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • tank tank
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributor statistics
    • Graph
    • Compare revisions
  • Issues 30
    • Issues 30
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 0
    • Merge requests 0
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Container Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • AURAAURA
  • tanktank
  • Merge requests
  • !5

Add api docs generated by swaggo/swag

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged robwa requested to merge feature/7-api-docs into master Mar 23, 2022
  • Overview 1
  • Commits 11
  • Pipelines 7
  • Changes 16

This MR adds API docs generation based on @equinox 2dba85db. You may build docs locally with make api-docs, generated files are Swagger/ OpenAPI version 2 and can be found in api/docs.

When running the dev server, Swagger UI is available at /api/docs/index.html.

The API is not changed with this MR. Endpoints are just annotated with comments according to swaggo/swag documentation.

An OpenAPI 3 scheme is generated in CI with openapi-generator-cli. It is available as an artifact of the job build-openapi-3-scheme.

Edited Mar 23, 2022 by robwa
Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: feature/7-api-docs