Postman-api-client NPM

postman_api

PostmanApi - JavaScript client for postman_api Postman API This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install postman_api --save

Finally, you need to build the module:

npm run build

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

To use the link you just defined in your project, switch to the directory you want to use your postman_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var PostmanApi = require('postman_api');


var api = new PostmanApi.APIApi()
var workspace = {{workspaceId}}; // {String} 
var xApiKey = "xApiKey_example"; // {String} 
var createAPIRequest = {"api":{"name":"Sync Service API","summary":"This is supposed to be a short summary.","description":"This is description."}}; // {CreateAPIRequest} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.createAPI(workspace, xApiKey, createAPIRequest, callback);

Documentation for API Endpoints

All URIs are relative to https://api.getpostman.com

Class	Method	HTTP request	Description
PostmanApi.APIApi	createAPI	POST /apis	Create API
PostmanApi.APIApi	deleteanAPI	DELETE /apis/{apiId}	Delete an API
PostmanApi.APIApi	getallAPIs	GET /apis	Get all APIs
PostmanApi.APIApi	singleAPI	GET /apis/{apiId}	Single API
PostmanApi.APIApi	updateanAPI	PUT /apis/{apiId}	Update an API
PostmanApi.APIVersionApi	createAPIVersion	POST /apis/{apiId}/versions	Create API Version
PostmanApi.APIVersionApi	deleteanAPIVersion	DELETE /apis/{apiId}/versions/{apiVersionId}	Delete an API Version
PostmanApi.APIVersionApi	getAllAPIVersions	GET /apis/{apiId}/versions	Get All API Versions
PostmanApi.APIVersionApi	getanAPIVersion	GET /apis/{apiId}/versions/{apiVersionId}	Get an API Version
PostmanApi.APIVersionApi	updateanAPIVersion	PUT /apis/{apiId}/versions/{apiVersionId}	Update an API Version
PostmanApi.CollectionsApi	allCollections	GET /collections	All Collections
PostmanApi.CollectionsApi	createCollection	POST /collections	Create Collection
PostmanApi.CollectionsApi	createaFork	POST /collections/fork/{collection_uid}	Create a Fork
PostmanApi.CollectionsApi	deleteCollection	DELETE /collections/{collection_uid}	Delete Collection
PostmanApi.CollectionsApi	mergeaFork	POST /collections/merge	Merge a Fork
PostmanApi.CollectionsApi	singleCollection	GET /collections/{collection_uid}	Single Collection
PostmanApi.CollectionsApi	updateCollection	PUT /collections/{collection_uid}	Update Collection
PostmanApi.EnvironmentsApi	allEnvironments	GET /environments	All Environments
PostmanApi.EnvironmentsApi	createEnvironment	POST /environments	Create Environment
PostmanApi.EnvironmentsApi	deleteEnvironment	DELETE /environments/{environment_uid}	Delete Environment
PostmanApi.EnvironmentsApi	singleEnvironment	GET /environments/{environment_uid}	Single Environment
PostmanApi.EnvironmentsApi	updateEnvironment	PUT /environments/{environment_uid}	Update Environment
PostmanApi.ImportApi	importexporteddata	POST /import/exported	Import exported data
PostmanApi.ImportApi	importexternalAPIspecification	POST /import/{importType}	Import external API specification
PostmanApi.MocksApi	allMocks	GET /mocks	All Mocks
PostmanApi.MocksApi	createMock	POST /mocks	Create Mock
PostmanApi.MocksApi	deleteMock	DELETE /mocks/{mock_uid}	Delete Mock
PostmanApi.MocksApi	publishMock	POST /mocks/{mock_uid}/publish	Publish Mock
PostmanApi.MocksApi	singleMock	GET /mocks/{mock_uid}	Single Mock
PostmanApi.MocksApi	unpublishMock	DELETE /mocks/{mock_uid}/unpublish	Unpublish Mock
PostmanApi.MocksApi	updateMock	PUT /mocks/{mock_uid}	Update Mock
PostmanApi.MonitorsApi	allMonitors	GET /monitors	All Monitors
PostmanApi.MonitorsApi	createMonitor	POST /monitors	Create Monitor
PostmanApi.MonitorsApi	deleteMonitor	DELETE /monitors/{monitor_uid}	Delete Monitor
PostmanApi.MonitorsApi	runaMonitor	POST /monitors/{monitor_uid}/run	Run a Monitor
PostmanApi.MonitorsApi	singleMonitor	GET /monitors/{monitor_uid}	Single Monitor
PostmanApi.MonitorsApi	updateMonitor	PUT /monitors/{monitor_uid}	Update Monitor
PostmanApi.RelationsApi	createrelations	POST /apis/{apiId}/versions/{apiVersionId}/relations	Create relations
PostmanApi.RelationsApi	getlinkedrelations	GET /apis/{apiId}/versions/{apiVersionId}/relations	Get linked relations
PostmanApi.RelationsApi	getrelationdetails	GET /apis/{apiId}/versions/{apiVersionId}/{relationType}/{relationId}	Get relation details
PostmanApi.RelationsApi	getrelationsbytype	GET /apis/{apiId}/versions/{apiVersionId}/{relationType}	Get relations by type
PostmanApi.SchemaApi	createSchema	POST /apis/{apiId}/versions/{apiVersionId}/schemas	Create Schema
PostmanApi.SchemaApi	createcollectionfromschema	POST /apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}/collections	Create collection from schema
PostmanApi.SchemaApi	getSchema	GET /apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}	Get Schema
PostmanApi.SchemaApi	updateSchema	PUT /apis/{apiId}/versions/{apiVersionId}/schemas/{schemaId}	Update Schema
PostmanApi.UserApi	aPIKeyOwner	GET /me	API Key Owner
PostmanApi.WorkspacesApi	allworkspaces	GET /workspaces	All workspaces
PostmanApi.WorkspacesApi	createWorkspace	POST /workspaces	Create Workspace
PostmanApi.WorkspacesApi	deleteWorkspace	DELETE /workspaces/{workspace_id}	Delete Workspace
PostmanApi.WorkspacesApi	singleworkspace	GET /workspaces/{workspace_id}	Single workspace
PostmanApi.WorkspacesApi	updateWorkspace	PUT /workspaces/{workspace_id}	Update Workspace

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

@babel/cli superagent

postman-uploader @everything-registry/sub-chunk-2463 @zalastax/nolb-postm

1.0.0

3 years ago