Giter Site home page Giter Site logo

Comments (3)

bajtos avatar bajtos commented on September 28, 2024

To implement this change, we have to migrate to Swagger spec v1.2 (transition docs).

Then we can use authorizations sections to describe auth. See petstore for an example of swagger descriptors including authorizations.

This is my rough idea:

When app.isAuthEnabled is not true, authorizations should be always empty (or not present at all).

Otherwise, the top-level swagger descriptor should configure access-token-based authorization:

authorizations: {
  accessToken : {
      // Authorization is a name of the HTTP header
      type: 'Authorization',
      passAs : 'header'
    }
}

Now for every public method, we need to decide whether anonymous access is allowed. If it isn't, then the method swagger description should include authorizations: { accessToken: [] } (I am not sure about the exact value here).

from loopback-component-explorer.

raymondfeng avatar raymondfeng commented on September 28, 2024

+1 to upgrade to Swagger 1.2 which will gives us a better api spec:

  • authorization
  • model schema
  • content-type/accept
  • error/status code

https://github.com/wordnik/swagger-core/wiki/1.2-transition

from loopback-component-explorer.

PerfectedApp avatar PerfectedApp commented on September 28, 2024

+1 to upgrade to Swagger 1.2

from loopback-component-explorer.

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.