forked from loafle/openapi-generator-original
d21613c6ab
* Do not set Content-Type to multipart/form-data It causes superagent to not add the boundary in the Content-Type * Run shell-scripts
104 lines
3.1 KiB
Markdown
104 lines
3.1 KiB
Markdown
# swagger_petstore____end____rn_n_r
|
|
|
|
SwaggerPetstoreEndRnNR - JavaScript client for swagger_petstore____end____rn_n_r
|
|
This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ *_/ ' \" =end --
|
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
|
|
- API version: 1.0.0 *_/ ' \" =end -- \\r\\n \\n \\r
|
|
- Package version: 1.0.0 *_/ =end -- \r\n \n \r
|
|
- Build package: class io.swagger.codegen.languages.JavascriptClientCodegen
|
|
|
|
## Installation
|
|
|
|
### For [Node.js](https://nodejs.org/)
|
|
|
|
#### npm
|
|
|
|
To publish the library as a [npm](https://www.npmjs.com/),
|
|
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).
|
|
|
|
Then install it via:
|
|
|
|
```shell
|
|
npm install swagger_petstore____end____rn_n_r --save
|
|
```
|
|
|
|
#### 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:
|
|
|
|
```shell
|
|
npm install GIT_USER_ID/GIT_REPO_ID --save
|
|
```
|
|
|
|
### For browser
|
|
|
|
The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):
|
|
|
|
```shell
|
|
browserify main.js > bundle.js
|
|
```
|
|
|
|
Then include *bundle.js* in the HTML pages.
|
|
|
|
## Getting Started
|
|
|
|
Please follow the [installation](#installation) instruction and execute the following JS code:
|
|
|
|
```javascript
|
|
var SwaggerPetstoreEndRnNR = require('swagger_petstore____end____rn_n_r');
|
|
|
|
var api = new SwaggerPetstoreEndRnNR.FakeApi()
|
|
|
|
var opts = {
|
|
'testCodeInjectEndRnNR': "testCodeInjectEndRnNR_example" // {String} To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
|
|
};
|
|
|
|
var callback = function(error, data, response) {
|
|
if (error) {
|
|
console.error(error);
|
|
} else {
|
|
console.log('API called successfully.');
|
|
}
|
|
};
|
|
api.testCodeInjectEndRnNR(opts, callback);
|
|
|
|
```
|
|
|
|
## Documentation for API Endpoints
|
|
|
|
All URIs are relative to *https://petstore.swagger.io *_/ ' \" =end -- \\r\\n \\n \\r/v2 *_/ ' \" =end -- \\r\\n \\n \\r*
|
|
|
|
Class | Method | HTTP request | Description
|
|
------------ | ------------- | ------------- | -------------
|
|
*SwaggerPetstoreEndRnNR.FakeApi* | [**testCodeInjectEndRnNR**](docs/FakeApi.md#testCodeInjectEndRnNR) | **PUT** /fake | To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|
|
|
|
## Documentation for Models
|
|
|
|
- [SwaggerPetstoreEndRnNR.ModelReturn](docs/ModelReturn.md)
|
|
|
|
|
|
## Documentation for Authorization
|
|
|
|
|
|
### api_key
|
|
|
|
- **Type**: API key
|
|
- **API key parameter name**: api_key */ ' " =end -- \r\n \n \r
|
|
- **Location**: HTTP header
|
|
|
|
### petstore_auth
|
|
|
|
- **Type**: OAuth
|
|
- **Flow**: implicit
|
|
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
|
|
- **Scopes**:
|
|
- write:pets: modify pets in your account *_/ ' \" =end -- \\r\\n \\n \\r
|
|
- read:pets: read your pets *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|