Documentation for Consuming generated code #15
Merged
Conversation
This file contains 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
| In some cases we may need to add headers to our requests. They can be added to a base configuration. Note that the original configuration will not be mutated, but a copy will be created with the new appended headers. We can use the following methods: | ||
| */ | ||
| let configWithHeaders1 = baseConfig.appending(headers: ["Accept": "application/json"]) | ||
| let configWithHeaders2 = baseConfig.appendingHeader(value: "application/json", forKey: "Accept") |
There was a problem hiding this comment.
Suggested change
| let configWithHeaders2 = baseConfig.appendingHeader(value: "application/json", forKey: "Accept") | |
| let configWithHeaders2 = baseConfig.appendingHeader(value: "application/json", forKey: "Accept") | |
| let configWithHeaders3 = baseConfig.appending(contentType: .json) |
|
|
||
| ## Inline data types | ||
|
|
||
| In order to have a proper generation, you need to define data models in the `components` section in OpenAPI, or in the `definitions` section in Swagger. Defining your data models inline can result in generated code that is not properly named and therefore difficult to use. |
There was a problem hiding this comment.
nested models: inline nested models are not supported - you need to define the nested model as a ref to components or definitions section.
|
|
||
| Nevertheless, Bow OpenAPI has some other limitations. | ||
|
|
||
| ## Inline data types |
There was a problem hiding this comment.
I think we should add information about encoding for body parameters - it is always being done with JSON encoder.
Documentation for integration in Xcode
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR includes documentation for the following pages: