-
-
Notifications
You must be signed in to change notification settings - Fork 7.5k
[rust-salvo] Add Rust server generator targeting the Salvo web framework #23772
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
Open
AuroraMaster
wants to merge
11
commits into
OpenAPITools:master
Choose a base branch
from
AuroraMaster:add-rust-salvo-server-generator
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
d848fbd
Add Rust Salvo server code generator
AuroraMaster c2bf428
Add comprehensive testing for Rust Salvo server generator
AuroraMaster 2e21d9f
[rust-salvo] Modernize generator for Salvo 0.93 and refresh deps
AuroraMaster cc6a292
[rust-salvo] Make generated petstore code pass cargo check
AuroraMaster 9026a85
[rust-salvo] Align declared feature set with rust-axum and refresh docs
AuroraMaster a0e03b5
[rust-salvo] Use Locale.ROOT for httpMethod.toLowerCase
AuroraMaster c6833b7
Remove CLAUDE.md from upstream branch
AuroraMaster 28880f9
[rust-salvo] Generate sample server (petstore)
AuroraMaster 77df781
[rust-salvo] Address PR review: per-op auth, serde rename, CI, README
AuroraMaster e488d1f
[rust-salvo] Preserve OAuth2 scopes in endpoint security annotation
eb7f229
[rust-salvo] Move sample into shared rust-server CI matrix
AuroraMaster 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
Some comments aren't visible on the classic Files Changed page.
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,11 @@ | ||
| generatorName: rust-salvo | ||
| outputDir: samples/server/petstore/rust-salvo/output/petstore | ||
| inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore.yaml | ||
| templateDir: modules/openapi-generator/src/main/resources/rust-salvo | ||
| generateAliasAsModel: true | ||
| additionalProperties: | ||
| hideGenerationTimestamp: "true" | ||
| packageName: petstore_salvo | ||
| homePageUrl: https://github.com/openapitools/openapi-generator | ||
| globalProperties: | ||
| skipFormModel: false | ||
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,236 @@ | ||
| --- | ||
| title: Documentation for the rust-salvo Generator | ||
| --- | ||
|
|
||
| ## METADATA | ||
|
|
||
| | Property | Value | Notes | | ||
| | -------- | ----- | ----- | | ||
| | generator name | rust-salvo | pass this to the generate command after -g | | ||
| | generator stability | BETA | | | ||
| | generator type | SERVER | | | ||
| | generator language | Rust | | | ||
| | generator default templating engine | mustache | | | ||
| | helpTxt | Generates a Rust server library using Salvo web framework. | | | ||
|
|
||
| ## CONFIG OPTIONS | ||
| These options may be applied as additional-properties (cli) or configOptions (plugins). Refer to [configuration docs](https://openapi-generator.tech/docs/configuration) for more details. | ||
|
|
||
| | Option | Description | Values | Default | | ||
| | ------ | ----------- | ------ | ------- | | ||
| |enableAuthMiddleware|Enable authentication middleware| |false| | ||
| |enableCorsMiddleware|Enable CORS middleware| |false| | ||
| |enableRequestValidation|Enable request validation middleware| |true| | ||
| |enableResponseValidation|Enable response validation middleware| |false| | ||
| |packageName|Rust crate name (convention: snake_case).| |salvo_openapi| | ||
| |packageVersion|Rust crate version.| |null| | ||
|
|
||
| ## IMPORT MAPPING | ||
|
|
||
| | Type/Alias | Imports | | ||
| | ---------- | ------- | | ||
|
|
||
|
|
||
| ## INSTANTIATION TYPES | ||
|
|
||
| | Type/Alias | Instantiated By | | ||
| | ---------- | --------------- | | ||
| |array|Vec| | ||
| |map|std::collections::HashMap| | ||
|
|
||
|
|
||
| ## LANGUAGE PRIMITIVES | ||
|
|
||
| <ul class="column-ul"> | ||
| <li>String</li> | ||
| <li>bool</li> | ||
| <li>char</li> | ||
| <li>f32</li> | ||
| <li>f64</li> | ||
| <li>i16</li> | ||
| <li>i32</li> | ||
| <li>i64</li> | ||
| <li>i8</li> | ||
| <li>isize</li> | ||
| <li>str</li> | ||
| <li>u16</li> | ||
| <li>u32</li> | ||
| <li>u64</li> | ||
| <li>u8</li> | ||
| <li>usize</li> | ||
| </ul> | ||
|
|
||
| ## RESERVED WORDS | ||
|
|
||
| <ul class="column-ul"> | ||
| <li>Self</li> | ||
| <li>abstract</li> | ||
| <li>as</li> | ||
| <li>async</li> | ||
| <li>await</li> | ||
| <li>become</li> | ||
| <li>box</li> | ||
| <li>break</li> | ||
| <li>const</li> | ||
| <li>continue</li> | ||
| <li>crate</li> | ||
| <li>do</li> | ||
| <li>dyn</li> | ||
| <li>else</li> | ||
| <li>enum</li> | ||
| <li>extern</li> | ||
| <li>false</li> | ||
| <li>final</li> | ||
| <li>fn</li> | ||
| <li>for</li> | ||
| <li>if</li> | ||
| <li>impl</li> | ||
| <li>in</li> | ||
| <li>let</li> | ||
| <li>loop</li> | ||
| <li>macro</li> | ||
| <li>match</li> | ||
| <li>mod</li> | ||
| <li>move</li> | ||
| <li>mut</li> | ||
| <li>override</li> | ||
| <li>priv</li> | ||
| <li>pub</li> | ||
| <li>ref</li> | ||
| <li>return</li> | ||
| <li>self</li> | ||
| <li>static</li> | ||
| <li>struct</li> | ||
| <li>super</li> | ||
| <li>trait</li> | ||
| <li>true</li> | ||
| <li>try</li> | ||
| <li>type</li> | ||
| <li>typeof</li> | ||
| <li>unsafe</li> | ||
| <li>unsized</li> | ||
| <li>use</li> | ||
| <li>virtual</li> | ||
| <li>where</li> | ||
| <li>while</li> | ||
| <li>yield</li> | ||
| </ul> | ||
|
|
||
| ## FEATURE SET | ||
|
|
||
|
|
||
| ### Client Modification Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |BasePath|✗|ToolingExtension | ||
| |Authorizations|✗|ToolingExtension | ||
| |UserAgent|✗|ToolingExtension | ||
| |MockServer|✗|ToolingExtension | ||
|
|
||
| ### Data Type Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Custom|✗|OAS2,OAS3 | ||
| |Int32|✓|OAS2,OAS3 | ||
| |Int64|✓|OAS2,OAS3 | ||
| |Float|✓|OAS2,OAS3 | ||
| |Double|✓|OAS2,OAS3 | ||
| |Decimal|✓|ToolingExtension | ||
| |String|✓|OAS2,OAS3 | ||
| |Byte|✓|OAS2,OAS3 | ||
| |Binary|✓|OAS2,OAS3 | ||
| |Boolean|✓|OAS2,OAS3 | ||
| |Date|✓|OAS2,OAS3 | ||
| |DateTime|✓|OAS2,OAS3 | ||
| |Password|✓|OAS2,OAS3 | ||
| |File|✓|OAS2 | ||
| |Uuid|✗| | ||
| |Array|✓|OAS2,OAS3 | ||
| |Null|✗|OAS3 | ||
| |AnyType|✗|OAS2,OAS3 | ||
| |Object|✓|OAS2,OAS3 | ||
| |Maps|✓|ToolingExtension | ||
| |CollectionFormat|✓|OAS2 | ||
| |CollectionFormatMulti|✓|OAS2 | ||
| |Enum|✓|OAS2,OAS3 | ||
| |ArrayOfEnum|✓|ToolingExtension | ||
| |ArrayOfModel|✓|ToolingExtension | ||
| |ArrayOfCollectionOfPrimitives|✓|ToolingExtension | ||
| |ArrayOfCollectionOfModel|✓|ToolingExtension | ||
| |ArrayOfCollectionOfEnum|✓|ToolingExtension | ||
| |MapOfEnum|✓|ToolingExtension | ||
| |MapOfModel|✓|ToolingExtension | ||
| |MapOfCollectionOfPrimitives|✓|ToolingExtension | ||
| |MapOfCollectionOfModel|✓|ToolingExtension | ||
| |MapOfCollectionOfEnum|✓|ToolingExtension | ||
|
|
||
| ### Documentation Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Readme|✗|ToolingExtension | ||
| |Model|✓|ToolingExtension | ||
| |Api|✓|ToolingExtension | ||
|
|
||
| ### Global Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Host|✓|OAS2,OAS3 | ||
| |BasePath|✓|OAS2,OAS3 | ||
| |Info|✗|OAS2,OAS3 | ||
| |Schemes|✗|OAS2,OAS3 | ||
| |PartialSchemes|✓|OAS2,OAS3 | ||
| |Consumes|✓|OAS2 | ||
| |Produces|✓|OAS2 | ||
| |ExternalDocumentation|✗|OAS2,OAS3 | ||
| |Examples|✗|OAS2,OAS3 | ||
| |XMLStructureDefinitions|✗|OAS2,OAS3 | ||
| |MultiServer|✗|OAS3 | ||
| |ParameterizedServer|✗|OAS3 | ||
| |ParameterStyling|✗|OAS3 | ||
| |Callbacks|✗|OAS3 | ||
| |LinkObjects|✗|OAS3 | ||
|
|
||
| ### Parameter Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Path|✓|OAS2,OAS3 | ||
| |Query|✓|OAS2,OAS3 | ||
| |Header|✓|OAS2,OAS3 | ||
| |Body|✓|OAS2 | ||
| |FormUnencoded|✓|OAS2 | ||
| |FormMultipart|✓|OAS2 | ||
| |Cookie|✓|OAS3 | ||
|
|
||
| ### Schema Support Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |Simple|✓|OAS2,OAS3 | ||
| |Composite|✓|OAS2,OAS3 | ||
| |Polymorphism|✗|OAS2,OAS3 | ||
| |Union|✗|OAS3 | ||
| |allOf|✓|OAS2,OAS3 | ||
| |anyOf|✓|OAS3 | ||
| |oneOf|✓|OAS3 | ||
| |not|✗|OAS3 | ||
|
|
||
| ### Security Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |BasicAuth|✓|OAS2,OAS3 | ||
| |ApiKey|✓|OAS2,OAS3 | ||
| |OpenIDConnect|✗|OAS3 | ||
| |BearerToken|✓|OAS3 | ||
| |OAuth2_Implicit|✗|OAS2,OAS3 | ||
| |OAuth2_Password|✗|OAS2,OAS3 | ||
| |OAuth2_ClientCredentials|✗|OAS2,OAS3 | ||
| |OAuth2_AuthorizationCode|✗|OAS2,OAS3 | ||
| |SignatureAuth|✗|OAS3 | ||
| |AWSV4Signature|✗|ToolingExtension | ||
|
|
||
| ### Wire Format Feature | ||
| | Name | Supported | Defined By | | ||
| | ---- | --------- | ---------- | | ||
| |JSON|✓|OAS2,OAS3 | ||
| |XML|✗|OAS2,OAS3 | ||
| |PROTOBUF|✗|ToolingExtension | ||
| |Custom|✓|OAS2,OAS3 |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
please add the new sample folder to the workflow: https://github.com/OpenAPITools/openapi-generator/blob/master/.github/workflows/samples-rust-server.yaml so that CI will test it moving forward