Skip to content
GitLab
Next
    • GitLab: the DevOps platform
    • Explore GitLab
    • Install GitLab
    • How GitLab compares
    • Get started
    • GitLab docs
    • GitLab Learn
  • Pricing
  • Talk to an expert
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
    Projects Groups Snippets
  • Sign up now
  • Login
  • Sign in / Register
  • GitLab GitLab
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
    • Locked Files
  • Issues 46,782
    • Issues 46,782
    • List
    • Boards
    • Service Desk
    • Milestones
    • Iterations
    • Requirements
  • Merge requests 1,538
    • Merge requests 1,538
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Artifacts
    • Schedules
    • Test Cases
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Container Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Metrics
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Code review
    • Insights
    • Issue
    • Repository
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • GitLab.orgGitLab.org
  • GitLabGitLab
  • Issues
  • #19515
Closed
Open
Issue created Sep 16, 2017 by Roger Meier@bufferoverflow🐋Contributor0 of 3 checklist items completed0/3 checklist items

Integrate with OpenAPI editor

Description

OpenAPI aka. Swagger is a widely used API description format. The idea is to:

  • render an API directly with swagger-ui within file view
  • provide a link to open an api spec directly within a swagger-editor
  • further options could be to store changed API from editor back to GitLab

The integration could be similar to plantuml.

Proposal

We would like to contribute this. /cc @siemens

Links / references

  • https://www.openapis.org/
  • https://swagger.io/swagger-ui/
  • https://swagger.io/swagger-editor/

Overview

  • What is it? Smooth integration for api development.
  • Why should someone use this feature? APIs are widely used.
  • What is the underlying (business) problem? faster development cycles without extra tools for APIs
  • How do you use this feature? Browser and edit API's

Use cases

Api development with OpenAPI is adopted within many areas.

Feature checklist

Make sure these are completed before closing the issue, with a link to the relevant commit.

  • Feature assurance
  • Documentation
  • Added to features.yml
Assignee
Assign to
Time tracking