swagger-api / swagger-api/swagger-codegen

Can we combine Swagger documentation, "Try it out" testing and SwaggerCodeGen together in one UI?

Open
#5,476 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

General: Suggestion
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

We wanted to combine Swagger documentation, "Try this" testing shown in Image-1 and SwaggerCodeGen having different client code shown in image-2 together in one UI?

Image-1:
image

Image-2:
image

As shown above, we have one UI which we generated using swagger UI (Image1). Also, we generated Swagger codegen (Image2). We wanted to combine both of this User interfaces in one single UI so that end customer can able to see documentation of API, "try it out" feature of API and also take/use client code as per the programming language selection for his application.

Can you please suggest or guide us how to combine these two separate User interfaces in one single User interface?

Your prompt reply is highly appreciated.

Thanks in advance.

2.3.0 | Apr/May 2017 | 1.0, 1.1, 1.2, 2.0 | Minor release with breaking changes

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

The issue mentions Swagger UI and Swagger Codegen but names no repository files, tests, or entry points. Start by locating the documentation UI and code-generation integration points in the repository, then determine whether a combined interface is supported. Done would require a defined integration scope and acceptance criteria for documentation, try-it-out testing, and language-specific client code.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
documentation, tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.