forked from loafle/openapi-generator-original
74 lines
2.4 KiB
Markdown
74 lines
2.4 KiB
Markdown
# Go API client for swagger
|
|
|
|
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 --
|
|
|
|
## Overview
|
|
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
|
|
|
|
- API version: 1.0.0 *_/ ' \" =end -- \\r\\n \\n \\r
|
|
- Package version: 1.0.0
|
|
- Build package: io.swagger.codegen.languages.GoClientCodegen
|
|
|
|
## Installation
|
|
Put the package under your project folder and add the following in import:
|
|
```
|
|
"./swagger"
|
|
```
|
|
|
|
## 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
|
|
------------ | ------------- | ------------- | -------------
|
|
*FakeApi* | [**TestCodeInjectEndRnNR**](docs/FakeApi.md#testcodeinjectendrnnr) | **Put** /fake | To test code injection *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|
|
|
|
## Documentation For Models
|
|
|
|
- [ModelReturn](docs/ModelReturn.md)
|
|
|
|
|
|
## Documentation For Authorization
|
|
|
|
## api_key
|
|
- **Type**: API key
|
|
|
|
Example
|
|
```
|
|
auth := context.WithValue(context.TODO(), sw.ContextAPIKey, sw.APIKey{
|
|
Key: "APIKEY",
|
|
Prefix: "Bearer", // Omit if not necessary.
|
|
})
|
|
r, err := client.Service.Operation(auth, args)
|
|
```
|
|
## 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
|
|
|
|
Example
|
|
```
|
|
auth := context.WithValue(context.TODO(), sw.ContextAccessToken, "ACCESSTOKENSTRING")
|
|
r, err := client.Service.Operation(auth, args)
|
|
```
|
|
|
|
Or via OAuth2 module to automaticly refresh tokens and perform user authentication.
|
|
```
|
|
import "golang.org/x/oauth2"
|
|
|
|
/ .. Perform OAuth2 round trip request and obtain a token .. //
|
|
|
|
tokenSource := oauth2cfg.TokenSource(createContext(httpClient), &token)
|
|
auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource)
|
|
r, err := client.Service.Operation(auth, args)
|
|
```
|
|
|
|
## Author
|
|
|
|
apiteam@swagger.io *_/ ' \" =end -- \\r\\n \\n \\r
|
|
|