@novice1/api-doc-generator - v1.0.0
    Preparing search index...

    Class Postman

    Postman collection generator.

    For now it is not possible to only send files outside of object property (multipart). Well, at least not tried yet but it definitely doesn't work with alternatives

    Implements

    Index

    Constructors

    constructor

    Methods

    add addEvent addFolder addFolders addHost addVariable getAuth getConsumes getDefaultSecurity getDescription getEventList getFolders getGenerateFoldersRule getHost getInfo getName getPostmanId getProtocolProfileBehavior getResponsesProperty getSchema getVariableList getVersion removeAll removeDefaultSecurity result setAuth setConsumes setDefaultSecurity setDescription setEventList setFolders setGenerateFoldersRule setHost setInfo setInfoProperty setName setPostmanId setProtocolProfileBehavior setResponsesProperty setSchema setVariableList setVersion

    Constructors

    Methods

    • Parameters

      • routes: RouteMeta[]

      Returns ProcessedRoute[]

      The added/updated routes

      import routing from '@novice1/routing';
      import { Postman } from '@novice1/api-doc-generator';

      const router = routing().post(...);
      const postman = new Postman();
      const routes = postman.add(router.getMeta());
      const { path, method, schema } = routes[0];

    • Parameters

      • routes: RouteMeta

      Returns ProcessedRoute[]

      The added/updated routes

      import routing from '@novice1/routing';
      import { Postman } from '@novice1/api-doc-generator';

      const router = routing().post(...);
      const postman = new Postman();
      const routes = postman.add(router.getMeta());
      const { path, method, schema } = routes[0];

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods