swagger-api / swagger-api/swagger-ui

Swagger-ui displaying only the paths (API Resources)

Open
#6,447 1 comment 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

Q&A (please complete the following information)
  • Browser: Chrome, FireFox
  • Version: [e.g. 22]
  • Method of installation: npm
  • Swagger-UI version: v3.34.0
  • Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0]
  • Portal technology: Angular v10.0.6
Content & configuration

Swagger/OpenAPI definition:

https://petstore.swagger.io/v2/swagger.json

Swagger-UI configuration options:

SwaggerUI({
  url: this.invokeUrl,
      requestInterceptor: (req) => {
        if (req.url === this.invokeUrl) {
          req.headers.Authorization = ""
          return req;
        }
      },
      domNode: this.eRef.nativeElement.querySelector('.swagger-container'),
      deepLinking: true,
      presets: [
        ApiResources.presets.apis
      ],
      defaultModelsExpandDepth: -1,
      defaultModelRendering: "model",
      showExtensions:false,
      withCredentials:false,
      displayOperationId:false,
      operationsSorter: "alpha",
      supportedSubmitMethods: [],
      securityDefinitions:{
})
Screenshots

image

How can we help?

Currently we are working on a business case that request us to displaying only the part of paths (API Resources with Samples if it's contains) without any other information like (API Name, Base URL, Schema, Descriptions, etc...). We are finding some existing configuration to remove the Models and disabling the Try on button and we use that.

If this point is not feasible right now, and you have another suggest solutions, please support us on that.

Thanks,,
Faisal.

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 the SwaggerUI configuration and the ApiResources.apis preset shown in the issue, then compare the current petstore definition output with the requested paths-only view. Determine whether existing configuration can hide API name, base URL, schemas, descriptions, models, and Try it out; done means a documented, reproducible way to display only paths and available samples.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.