Code Monkey home page Code Monkey logo

Comments (5)

scottie1984 avatar scottie1984 commented on August 11, 2024

What are you trying to achieve? You should pass your swagger document into the setup function:

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerSpec));

This will tie the swaggerUi to your swagger document. The Explore option I can remove as its not intended to be used.

The intention of the module is to tie your swagger doc to the UI in the setup function. I am happy to make changes and serve other purposes if you have another use case.

from swagger-ui-express.

abnoba12 avatar abnoba12 commented on August 11, 2024

Short Answer: Removing the explorer would be perfect for what I need.

Long Answer: I originally wasn't aware of the "host" and "basePath" parameters. In the example configurations for the swagger-jsdoc module there is no reference to them. When the "host" and "basePath" parameters are left blank the swagger UI defaults to using http://petstore.swagger.io for the host.

So can you please remove the explorer from your module and add mention the "host" and "basePath" parameters in your documentation.

from swagger-ui-express.

scottie1984 avatar scottie1984 commented on August 11, 2024

Ah, that makes sense now as to why you wanted the url to default to "window.location.origin". I wasn't aware that if you left host and basePath parameters blank it caused this.

I will fix it over the weekend to default to "window.location.origin". I will also remove the explorer.

from swagger-ui-express.

scottie1984 avatar scottie1984 commented on August 11, 2024

I set the default url to window.location.origin and removed the explorer by default.

Can you test and let me know if this fixes it for you?

from swagger-ui-express.

abnoba12 avatar abnoba12 commented on August 11, 2024

This worked perfect for me

from swagger-ui-express.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.