swagger-api / swagger-api/swagger-ui

Render only one API action method with swagger ui on fly

Open
#6,031 9 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: question
Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

I am working on swagger-ui with the help of swashbuckle.net.core code base(https://github.com/domaindrivendev/Swashbuckle.AspNetCore/tree/master/src).i have found that rendering all contoller action method in swagger-ui (index.html).but i want only one action method should be called on index.html from any other html after clicking any link button which is specify the action method name.

  1. how to achieve this scenario and
    2.how swagger.json file will render only one action method.
    3.there is any way we can filter based on operationid on group of tag. so that it display only one opratonid api action method.
    4.can we achieve on both server and client code
    please help.

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

Start with index.html and the Swagger UI configuration, then compare it with the generated swagger.json. Determine whether selecting one operation by operationId and tag requires client-side filtering, server-side document generation, or both. Done means documenting a supported way to display only the requested action method.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, openapi
Domain
documentation, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.