|
| 1 | +# Go API client for openapi |
| 2 | + |
| 3 | +Echo Server API |
| 4 | + |
| 5 | +## Overview |
| 6 | +This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client. |
| 7 | + |
| 8 | +- API version: 0.1.0 |
| 9 | +- Package version: 1.0.0 |
| 10 | +- Build package: org.openapitools.codegen.languages.GoClientCodegen |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +Install the following dependencies: |
| 15 | + |
| 16 | +```shell |
| 17 | +go get github.com/stretchr/testify/assert |
| 18 | +go get golang.org/x/net/context |
| 19 | +``` |
| 20 | + |
| 21 | +Put the package under your project folder and add the following in import: |
| 22 | + |
| 23 | +```golang |
| 24 | +import openapi "github.com/GIT_USER_ID/GIT_REPO_ID" |
| 25 | +``` |
| 26 | + |
| 27 | +To use a proxy, set the environment variable `HTTP_PROXY`: |
| 28 | + |
| 29 | +```golang |
| 30 | +os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port") |
| 31 | +``` |
| 32 | + |
| 33 | +## Configuration of Server URL |
| 34 | + |
| 35 | +Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification. |
| 36 | + |
| 37 | +### Select Server Configuration |
| 38 | + |
| 39 | +For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`. |
| 40 | + |
| 41 | +```golang |
| 42 | +ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1) |
| 43 | +``` |
| 44 | + |
| 45 | +### Templated Server URL |
| 46 | + |
| 47 | +Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`. |
| 48 | + |
| 49 | +```golang |
| 50 | +ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{ |
| 51 | + "basePath": "v2", |
| 52 | +}) |
| 53 | +``` |
| 54 | + |
| 55 | +Note, enum values are always validated and all unused variables are silently ignored. |
| 56 | + |
| 57 | +### URLs Configuration per Operation |
| 58 | + |
| 59 | +Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. |
| 60 | +An operation is uniquely identified by `"{classname}Service.{nickname}"` string. |
| 61 | +Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps. |
| 62 | + |
| 63 | +```golang |
| 64 | +ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{ |
| 65 | + "{classname}Service.{nickname}": 2, |
| 66 | +}) |
| 67 | +ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{ |
| 68 | + "{classname}Service.{nickname}": { |
| 69 | + "port": "8443", |
| 70 | + }, |
| 71 | +}) |
| 72 | +``` |
| 73 | + |
| 74 | +## Documentation for API Endpoints |
| 75 | + |
| 76 | +All URIs are relative to *http://localhost:3000* |
| 77 | + |
| 78 | +Class | Method | HTTP request | Description |
| 79 | +------------ | ------------- | ------------- | ------------- |
| 80 | +*AuthAPI* | [**TestAuthHttpBasic**](docs/AuthAPI.md#testauthhttpbasic) | **Post** /auth/http/basic | To test HTTP basic authentication |
| 81 | +*BodyAPI* | [**TestBinaryGif**](docs/BodyAPI.md#testbinarygif) | **Post** /binary/gif | Test binary (gif) response body |
| 82 | +*BodyAPI* | [**TestBodyApplicationOctetstreamBinary**](docs/BodyAPI.md#testbodyapplicationoctetstreambinary) | **Post** /body/application/octetstream/binary | Test body parameter(s) |
| 83 | +*BodyAPI* | [**TestBodyMultipartFormdataArrayOfBinary**](docs/BodyAPI.md#testbodymultipartformdataarrayofbinary) | **Post** /body/application/octetstream/array_of_binary | Test array of binary in multipart mime |
| 84 | +*BodyAPI* | [**TestEchoBodyFreeFormObjectResponseString**](docs/BodyAPI.md#testechobodyfreeformobjectresponsestring) | **Post** /echo/body/FreeFormObject/response_string | Test free form object |
| 85 | +*BodyAPI* | [**TestEchoBodyPet**](docs/BodyAPI.md#testechobodypet) | **Post** /echo/body/Pet | Test body parameter(s) |
| 86 | +*BodyAPI* | [**TestEchoBodyPetResponseString**](docs/BodyAPI.md#testechobodypetresponsestring) | **Post** /echo/body/Pet/response_string | Test empty response body |
| 87 | +*BodyAPI* | [**TestEchoBodyTagResponseString**](docs/BodyAPI.md#testechobodytagresponsestring) | **Post** /echo/body/Tag/response_string | Test empty json (request body) |
| 88 | +*FormAPI* | [**TestFormIntegerBooleanString**](docs/FormAPI.md#testformintegerbooleanstring) | **Post** /form/integer/boolean/string | Test form parameter(s) |
| 89 | +*FormAPI* | [**TestFormOneof**](docs/FormAPI.md#testformoneof) | **Post** /form/oneof | Test form parameter(s) for oneOf schema |
| 90 | +*HeaderAPI* | [**TestHeaderIntegerBooleanString**](docs/HeaderAPI.md#testheaderintegerbooleanstring) | **Get** /header/integer/boolean/string | Test header parameter(s) |
| 91 | +*PathAPI* | [**TestsPathStringPathStringIntegerPathInteger**](docs/PathAPI.md#testspathstringpathstringintegerpathinteger) | **Get** /path/string/{path_string}/integer/{path_integer} | Test path parameter(s) |
| 92 | +*QueryAPI* | [**TestEnumRefString**](docs/QueryAPI.md#testenumrefstring) | **Get** /query/enum_ref_string | Test query parameter(s) |
| 93 | +*QueryAPI* | [**TestQueryDatetimeDateString**](docs/QueryAPI.md#testquerydatetimedatestring) | **Get** /query/datetime/date/string | Test query parameter(s) |
| 94 | +*QueryAPI* | [**TestQueryIntegerBooleanString**](docs/QueryAPI.md#testqueryintegerbooleanstring) | **Get** /query/integer/boolean/string | Test query parameter(s) |
| 95 | +*QueryAPI* | [**TestQueryStyleDeepObjectExplodeTrueObject**](docs/QueryAPI.md#testquerystyledeepobjectexplodetrueobject) | **Get** /query/style_deepObject/explode_true/object | Test query parameter(s) |
| 96 | +*QueryAPI* | [**TestQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryAPI.md#testquerystyledeepobjectexplodetrueobjectallof) | **Get** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s) |
| 97 | +*QueryAPI* | [**TestQueryStyleFormExplodeTrueArrayString**](docs/QueryAPI.md#testquerystyleformexplodetruearraystring) | **Get** /query/style_form/explode_true/array_string | Test query parameter(s) |
| 98 | +*QueryAPI* | [**TestQueryStyleFormExplodeTrueObject**](docs/QueryAPI.md#testquerystyleformexplodetrueobject) | **Get** /query/style_form/explode_true/object | Test query parameter(s) |
| 99 | +*QueryAPI* | [**TestQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryAPI.md#testquerystyleformexplodetrueobjectallof) | **Get** /query/style_form/explode_true/object/allOf | Test query parameter(s) |
| 100 | + |
| 101 | + |
| 102 | +## Documentation For Models |
| 103 | + |
| 104 | + - [Bird](docs/Bird.md) |
| 105 | + - [Category](docs/Category.md) |
| 106 | + - [DataQuery](docs/DataQuery.md) |
| 107 | + - [DefaultValue](docs/DefaultValue.md) |
| 108 | + - [NumberPropertiesOnly](docs/NumberPropertiesOnly.md) |
| 109 | + - [Pet](docs/Pet.md) |
| 110 | + - [Query](docs/Query.md) |
| 111 | + - [StringEnumRef](docs/StringEnumRef.md) |
| 112 | + - [Tag](docs/Tag.md) |
| 113 | + - [TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter](docs/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.md) |
| 114 | + - [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md) |
| 115 | + |
| 116 | + |
| 117 | +## Documentation For Authorization |
| 118 | + |
| 119 | + |
| 120 | +Authentication schemes defined for the API: |
| 121 | +### http_auth |
| 122 | + |
| 123 | +- **Type**: HTTP basic authentication |
| 124 | + |
| 125 | +Example |
| 126 | + |
| 127 | +```golang |
| 128 | +auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ |
| 129 | + UserName: "username", |
| 130 | + Password: "password", |
| 131 | +}) |
| 132 | +r, err := client.Service.Operation(auth, args) |
| 133 | +``` |
| 134 | + |
| 135 | + |
| 136 | +## Documentation for Utility Methods |
| 137 | + |
| 138 | +Due to the fact that model structure members are all pointers, this package contains |
| 139 | +a number of utility functions to easily obtain pointers to values of basic types. |
| 140 | +Each of these functions takes a value of the given basic type and returns a pointer to it: |
| 141 | + |
| 142 | +* `PtrBool` |
| 143 | +* `PtrInt` |
| 144 | +* `PtrInt32` |
| 145 | +* `PtrInt64` |
| 146 | +* `PtrFloat` |
| 147 | +* `PtrFloat32` |
| 148 | +* `PtrFloat64` |
| 149 | +* `PtrString` |
| 150 | +* `PtrTime` |
| 151 | + |
| 152 | +## Author |
| 153 | + |
| 154 | +team@openapitools.org |
| 155 | + |
0 commit comments