Skip to content

api.md

Latest commit

 

History

History
25 lines (19 loc) · 967 Bytes

api.md

File metadata and controls

25 lines (19 loc) · 967 Bytes

Swagger Client API

Swagger Client exposes these functionalities for OpenAPI 2.0 and OpenAPI 3:

  • Static methods for...
    • HTTP Client (http)
    • Document Resolver (monolithic & subtree) (resolve, resolveSubtree)
    • TryItOut Executor (buildRequest, execute)
  • A constructor with the methods...
    • HTTP Client, for convenience (http)
    • Document Resolver, which will use url or spec from the instance (resolve)
    • TryItOut Executor, bound to the http and spec instance properties (execute)
    • Tags Interface, also bound to the instance

It is also possible to use SwaggerClient without explicitly instantiating the constructor.

import SwaggerClient from 'swagger-client';

new SwaggerClient('http://petstore.swagger.io/v2/swagger.json');
SwaggerClient('http://petstore.swagger.io/v2/swagger.json');
// these two lines are equivalent

If you call the constructor as function, constructor is instantiated for you implicitly.