swagger-api / swagger-api/swagger-ui

Two `host` urls - Production & Test

Open
#7,845 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

In default json response (for example here) its json data has:

{
    swagger: "2.0",
    info: {
        title: "...",
        termsOfService": "..."
    },
    host": "https://api-adapter.backend.currency.com/ ]\n[ Base demo URL: http://demo-api-adapter.backend.currency.com",

as you see, the host key has incorrect value, because I suppose there was no way otherwise for author, to set them both. So, I suggest there was (in addition to host) another key , i.e. host-test (or whatever). because there are many services which has production & test(demo) hosts separated, with same API scheme.

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 linked default JSON response and inspect how Swagger UI interprets the current host value. Determine whether a separate production/test host representation is supported by the relevant API format, then verify that both URLs are represented without corrupting the default response.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api
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.