Git Product home page Git Product logo

Comments (3)

jfmmm avatar jfmmm commented on May 26, 2024 1

this did the trick #54

from feathers-swagger.

jfmmm avatar jfmmm commented on May 26, 2024

Need this too, that delete methods for authentification make no sense without a blacklist feature.

from feathers-swagger.

idealley avatar idealley commented on May 26, 2024

For normal services if you do not use some methods such as patch, delete, etc delete them from your class and leave only those that you are actually using.

If it is a method that you use you can delete it after the doc has been generated:

delete app.docs.paths['/authentication/{id}'];

here is a full implementation of a swagger doc for the the authentication service:

  // Adding swagger to the authentication
  app.configure(Object.assign(authentication(config), {
    docs: def
  }));
  
  // if I do not want to show that documentation
  delete app.docs.paths['/authentication/{id}'];
  app.docs.paths['/authentication'].post = Object.assign(
    {}, 
    app.docs.paths['/authentication'].post, def.post);

 // fixing some elements that were not merged
 app.docs.tags[0].description = def.description;

def is simply a javascript object where I keep my custom documentation for the endpoint.

for a normal service if do the following:

  // Initialize our service with any options it requires
  app.use('/news', Object.assign(createService(options), { docs, id: 'slug' }));

This is the only line you need, docs is again my custom object, idis to modify the id of used in the documentation, so that it showed slug

from feathers-swagger.

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.