Generate convenience initializers that flatten some nested scopes #22
Comments
czechboy0
added
🆕 semver/minor
|
For unwrapping, let's see if this could work: |
|
@czechboy0 this would work in a I think we still need some heuristics for what to name these and when to generate them. I'm still not sure how much value that work will add when adopters can write the same in their code. I think conveniences on for creating inputs and outputs will probably add more value. WDYT? |
Yeah, in a guard, if, or a switch. Just wanted to note here that once can unwrap more than one level in one go.
Agreed. Right now I'm just dumping thoughts in this issue, I don't yet have a good idea of how we approach improving these. |
|
Ah nevermind, that won't work as the response associate value us a struct, not the body enum itself. |
czechboy0
added
size/L
…tputs (#308) ### Motivation The review period for SOAR-0007 (Shorthand APIs for inputs and outputs) has now concluded. This pull request adds the required SPIs to the runtime library to throw a runtime error when the response and/or body does not match that of the shorthand API being used. For further context, please review the proposal itself.[^1] [^1]: #291 ### Modifications - Add support for computed properties with effects (e.g. throwing getters). - Generate a protocol extension to `APIProtocol` with an overload for each operation that lifts each of the parameters of `Input.init` as function parameters. - Generate a throwing computed property for each enum case related to a documented outcome, which will return the associated value for the expected case, or throw a runtime error if the value is a different enum case. ### Result Code that used to be written like this ```swift // before switch try await client.getGreeting(.init()) { case .ok(let response): switch response.body { case .json(let body): print(body.message) } case .undocumented(statusCode: _, _): throw UnexpectedResponseError() } // after print(try await client.getGreeting().ok.body.json.message) // ^ ^ ^ ^ // | | | `- (New) Throws if body did not conform to documented JSON. // | | | // | | `- (New) Throws if HTTP response is not 200 (OK). // | | // | `- (New) No need to wrap parameters in input value. // | // `- (Existing) Throws if there is an error making the API call. ``` ### Test Plan This PR includes updates to the various tests: - `SnippetBasedReferenceTests` - `FileBasedReferenceTests` - `PetstoreConsumerTests` ### Related Issues - Resolves #22 - Resolves #104 - Resolves #145 --------- Signed-off-by: Si Beaumont <[email protected]>
### Motivation We'd like to run a proposal for generating additional API to simplify providing operation inputs and handling operation outputs for simple API calls with just one successful outcome. ### Modifications - Add SOAR-0007: Shorthand APIs for operation inputs and outputs (See the proposal itself for details)[^1] ### Result n/a ### Test Plan n/a ### Related Issues #22, #104, #105, #145 [^1]: https://github.com/apple/swift-openapi-generator/pull/291/files --------- Signed-off-by: Si Beaumont <[email protected]>
Creating input types is quite verbose because they contain multiple nested enums. (e.g.
.ok(.init(headers: .init(), body: .json(...)))).It may be useful to generate static helper functions on the output type so it's possible to write
.ok(body: .json(...))instead, or even.ok(...)directly.We have to be careful here, though, as it's possible to go very far and generate a ton of conveniences, that end up making the API more difficult to understand. So will require a well thought-out proposal first, describing which high-value conveniences we should generate, and how we evaluate further requests.
We also need to keep in mind that the generator complexity shouldn't be significantly increased with this work, as per https://github.com/apple/swift-openapi-generator/blob/main/Sources/swift-openapi-generator/Documentation.docc/Articles/Project-scope-and-goals.md#principle-reduce-complexity-of-the-generator-implementation
The text was updated successfully, but these errors were encountered: