[FR] Merge/persist state of generated docs to allow customization without overriding it about express-oas-generator HOT 7 CLOSED

@pedrokohler, @sarpik there is a way to persist you descriptions and any other changes during runs. The second argument of init() method could be a callback function. Here is an example:

generator.init(app, function(spec) {
    _.set(spec, 'info.title', 'New Title');
    _.set(spec, 'paths[\'/path\'].get.parameters[0].example', 2);
    return spec;
});

There are several ways to implement it:

• programmatically: just like in the example
• with use of JSONPatch: json patch file is stored separately in the repo and is used by callback function. there are some JS libraries simplifying JSON patching like http://jsonpatchjs.com/

from express-oas-generator.

the _ is lodash

@sarpik I mean, obviously! Sorry about that! LOL!

from express-oas-generator.

I'm not sure if we've implemented this in the advanced usage example, will take a look soon.

the _ is lodash -- you could instead just use

spec.info.title = 'New Title' etc.:D

from express-oas-generator.

Haha no problem stuff like this always happens:D

from express-oas-generator.

@pedrokohler with advanced usage this is how it looks like:

let app = express();
/** place handleResponses as the very first middleware */
expressOasGenerator.handleResponses(app, {
  predefinedSpec: function(spec) {
    _.set(spec, 'info.title', 'New Title');
    _.set(spec, 'paths[\'/path\'].get.parameters[0].example', 2);
    return spec;
  }
});

/** initialize your `app` and routes */

/** place handleRequests as the very last middleware */
expressOasGenerator.handleRequests();
app.listen(PORT);

from express-oas-generator.

@mpashkovskiy you should call this in the default export of the package despite of if you're implementing the advanced usage? Like that:

const generator = require('express-oas-generator');
const { handleResponses, handleRequests } = generator;

generator.init(app, function(spec) {
  _.set(spec, 'info.title', 'New Title');
  _.set(spec, 'paths[\'/path\'].get.parameters[0].example', 2);
  return spec;
});

Also, my linter complains about this _ out of nowhere. What is that supposed to be and where does it come from?

from express-oas-generator.

I think this question is resolved. Isn't it? Feel free to reopen if need any assistance.

from express-oas-generator.