-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
Add tests for withXml option in Go client generator #21913
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| generatorName: go | ||
| outputDir: samples/openapi3/client/petstore/go-petstore-withXml | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-addpet-only.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/go | ||
| additionalProperties: | ||
| enumClassPrefix: "true" | ||
| packageName: petstore | ||
| disallowAdditionalPropertiesIfNotPresent: false | ||
| withXml: false | ||
24 changes: 24 additions & 0 deletions
24
samples/openapi3/client/petstore/go-petstore-withXml/.gitignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| # Compiled Object files, Static and Dynamic libs (Shared Objects) | ||
| *.o | ||
| *.a | ||
| *.so | ||
|
|
||
| # Folders | ||
| _obj | ||
| _test | ||
|
|
||
| # Architecture specific extensions/prefixes | ||
| *.[568vq] | ||
| [568vq].out | ||
|
|
||
| *.cgo1.go | ||
| *.cgo2.c | ||
| _cgo_defun.c | ||
| _cgo_gotypes.go | ||
| _cgo_export.* | ||
|
|
||
| _testmain.go | ||
|
|
||
| *.exe | ||
| *.test | ||
| *.prof |
23 changes: 23 additions & 0 deletions
23
samples/openapi3/client/petstore/go-petstore-withXml/.openapi-generator-ignore
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| # OpenAPI Generator Ignore | ||
| # Generated by openapi-generator https://github.com/openapitools/openapi-generator | ||
|
|
||
| # Use this file to prevent files from being overwritten by the generator. | ||
| # The patterns follow closely to .gitignore or .dockerignore. | ||
|
|
||
| # As an example, the C# client generator defines ApiClient.cs. | ||
| # You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line: | ||
| #ApiClient.cs | ||
|
|
||
| # You can match any string of characters against a directory, file or extension with a single asterisk (*): | ||
| #foo/*/qux | ||
| # The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux | ||
|
|
||
| # You can recursively match patterns against a directory, file or extension with a double asterisk (**): | ||
| #foo/**/qux | ||
| # This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux | ||
|
|
||
| # You can also negate patterns with an exclamation (!). | ||
| # For example, you can ignore all files in a docs folder with the file extension .md: | ||
| #docs/*.md | ||
| # Then explicitly reverse the ignore rule for a single file: | ||
| #!docs/README.md |
19 changes: 19 additions & 0 deletions
19
samples/openapi3/client/petstore/go-petstore-withXml/.openapi-generator/FILES
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| .gitignore | ||
| .travis.yml | ||
| README.md | ||
| api/openapi.yaml | ||
| api_pet.go | ||
| client.go | ||
| configuration.go | ||
| docs/Category.md | ||
| docs/Pet.md | ||
| docs/PetAPI.md | ||
| docs/Tag.md | ||
| git_push.sh | ||
| go.mod | ||
| go.sum | ||
| model_category.go | ||
| model_pet.go | ||
| model_tag.go | ||
| response.go | ||
| utils.go |
1 change: 1 addition & 0 deletions
1
samples/openapi3/client/petstore/go-petstore-withXml/.openapi-generator/VERSION
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| 7.16.0-SNAPSHOT |
8 changes: 8 additions & 0 deletions
8
samples/openapi3/client/petstore/go-petstore-withXml/.travis.yml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| language: go | ||
|
|
||
| install: | ||
| - go get -d -v . | ||
|
|
||
| script: | ||
| - go build -v ./ | ||
|
|
145 changes: 145 additions & 0 deletions
145
samples/openapi3/client/petstore/go-petstore-withXml/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| # Go API client for petstore | ||
|
|
||
| This is a sample server Petstore server. For this sample, you can use the api key `special-key` to test the authorization filters. | ||
|
|
||
| ## Overview | ||
| 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. | ||
|
|
||
| - API version: 1.0.0 | ||
| - Package version: 1.0.0 | ||
| - Generator version: 7.16.0-SNAPSHOT | ||
| - Build package: org.openapitools.codegen.languages.GoClientCodegen | ||
|
|
||
| ## Installation | ||
|
|
||
| Install the following dependencies: | ||
|
|
||
| ```sh | ||
| go get github.com/stretchr/testify/assert | ||
| go get golang.org/x/oauth2 | ||
| go get golang.org/x/net/context | ||
| ``` | ||
|
|
||
| Put the package under your project folder and add the following in import: | ||
|
|
||
| ```go | ||
| import petstore "github.com/GIT_USER_ID/GIT_REPO_ID" | ||
| ``` | ||
|
|
||
| To use a proxy, set the environment variable `HTTP_PROXY`: | ||
|
|
||
| ```go | ||
| os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port") | ||
| ``` | ||
|
|
||
| ## Configuration of Server URL | ||
|
|
||
| Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification. | ||
|
|
||
| ### Select Server Configuration | ||
|
|
||
| For using other server than the one defined on index 0 set context value `petstore.ContextServerIndex` of type `int`. | ||
|
|
||
| ```go | ||
| ctx := context.WithValue(context.Background(), petstore.ContextServerIndex, 1) | ||
| ``` | ||
|
|
||
| ### Templated Server URL | ||
|
|
||
| Templated server URL is formatted using default variables from configuration or from context value `petstore.ContextServerVariables` of type `map[string]string`. | ||
|
|
||
| ```go | ||
| ctx := context.WithValue(context.Background(), petstore.ContextServerVariables, map[string]string{ | ||
| "basePath": "v2", | ||
| }) | ||
| ``` | ||
|
|
||
| Note, enum values are always validated and all unused variables are silently ignored. | ||
|
|
||
| ### URLs Configuration per Operation | ||
|
|
||
| Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. | ||
| An operation is uniquely identified by `"{classname}Service.{nickname}"` string. | ||
| Similar rules for overriding default operation server index and variables applies by using `petstore.ContextOperationServerIndices` and `petstore.ContextOperationServerVariables` context maps. | ||
|
|
||
| ```go | ||
| ctx := context.WithValue(context.Background(), petstore.ContextOperationServerIndices, map[string]int{ | ||
| "{classname}Service.{nickname}": 2, | ||
| }) | ||
| ctx = context.WithValue(context.Background(), petstore.ContextOperationServerVariables, map[string]map[string]string{ | ||
| "{classname}Service.{nickname}": { | ||
| "port": "8443", | ||
| }, | ||
| }) | ||
| ``` | ||
|
|
||
| ## Documentation for API Endpoints | ||
|
|
||
| All URIs are relative to *http://petstore.swagger.io/v2* | ||
|
|
||
| Class | Method | HTTP request | Description | ||
| ------------ | ------------- | ------------- | ------------- | ||
| *PetAPI* | [**AddPet**](docs/PetAPI.md#addpet) | **Post** /pet | Add a new pet to the store | ||
|
|
||
|
|
||
| ## Documentation For Models | ||
|
|
||
| - [Category](docs/Category.md) | ||
| - [Pet](docs/Pet.md) | ||
| - [Tag](docs/Tag.md) | ||
|
|
||
|
|
||
| ## Documentation For Authorization | ||
|
|
||
|
|
||
| Authentication schemes defined for the API: | ||
| ### petstore_auth | ||
|
|
||
|
|
||
| - **Type**: OAuth | ||
| - **Flow**: implicit | ||
| - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog | ||
| - **Scopes**: | ||
| - **write:pets**: modify pets in your account | ||
| - **read:pets**: read your pets | ||
|
|
||
| Example | ||
|
|
||
| ```go | ||
| auth := context.WithValue(context.Background(), petstore.ContextAccessToken, "ACCESSTOKENSTRING") | ||
| r, err := client.Service.Operation(auth, args) | ||
| ``` | ||
|
|
||
| Or via OAuth2 module to automatically refresh tokens and perform user authentication. | ||
|
|
||
| ```go | ||
| 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, petstore.ContextOAuth2, tokenSource) | ||
| r, err := client.Service.Operation(auth, args) | ||
| ``` | ||
|
|
||
|
|
||
| ## Documentation for Utility Methods | ||
|
|
||
| Due to the fact that model structure members are all pointers, this package contains | ||
| a number of utility functions to easily obtain pointers to values of basic types. | ||
| Each of these functions takes a value of the given basic type and returns a pointer to it: | ||
|
|
||
| * `PtrBool` | ||
| * `PtrInt` | ||
| * `PtrInt32` | ||
| * `PtrInt64` | ||
| * `PtrFloat` | ||
| * `PtrFloat32` | ||
| * `PtrFloat64` | ||
| * `PtrString` | ||
| * `PtrTime` | ||
|
|
||
| ## Author | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.