-
-
Notifications
You must be signed in to change notification settings - Fork 158
Move existing integration to JADNC #1076
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 14 commits
Commits
Show all changes
37 commits
Select commit
Hold shift + click to select a range
1c099e7
Copied integration and fixed compilation errors
maurei 54a023f
Add models and adjusted models in OpenAPI document tests such that i …
maurei 09ab5c0
Add FlightAttendantController to used controllers
maurei 19cc14d
Added client library with tests to project; made adjustmets to the mo…
maurei ec2ccaf
Adjusted build script to create OpenApiClient artifact, added documen…
maurei c6d691d
Adjusted docs and minor refactors
maurei ef2753e
Replace resource name formatter with internal one
maurei b3cdc7a
Removed JsonApiInputFormatter workaround
maurei a955616
Merge branch 'openapi' into oa/existing-integration
maurei bad9aad
Moved full document test to ExistingOpenApiIntegration test folder, w…
maurei ea46194
Disabled OpenAPI for nonjson and operations controller, as these are …
maurei a0d5bff
review feedback on docs
maurei 280e449
Add a very minimal example of a generated OpenAPI client for JsonApiD…
maurei 7b3d1ef
Fixed inspect and cleanup code issues that do not appear when execute…
maurei ba42b77
rename existing to legacy in ExistingOpenApiIntegration folder and na…
maurei ecd971e
moved OpenApiClient to OpenApi.Client
maurei 37a95b3
Configure NSwag to generate a client with access modifier set to inte…
maurei da1db37
Move OpenAPI client tests to dedicated test project, cleared up some …
maurei f71bbea
Some adjustments to stay closer to 1-on-1 model mapping from the priv…
maurei 348dffa
review feedback
maurei e88c762
Process inspectcode issues that do not appear when run locally
maurei 54ac898
Update package reference in build script
maurei 83ac507
Changed models to stay closer 1-to-1 mapping. Changed 'OpenApiClient…
maurei aaf59a6
process review feedback
maurei 1baed2d
rename ClassName in client test project
maurei 65430a8
Updated example client project using Visual Studio defaults and updat…
520c618
Layout tweaks and fixes
b72d823
fixed failed automatic rename 'openApiOpenApi'
maurei 43cec51
Merge branch 'oa/existing-integration' of https://github.com/json-api…
maurei 605d2ce
reduced changed wrt private version of this test
maurei 8c2a7b4
Changed ID type from to for Flight
maurei a83de89
ReserveCabinPersonnel -> Purser, CabinPersonnel -> CabinCrewMembers
maurei 8ceff7b
fixed failed automatic rename 'openApiOpenApi'
maurei 5a4a06f
Flight: replaced OperatingAirplane with Purser, added to many relatio…
maurei 7a88a64
Review feedback
maurei 4073c3f
Fix client lifetime test
maurei d3ebfaf
Feedback
maurei 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
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,137 @@ | ||
| # OpenAPI Client Library | ||
|
|
||
| You can generate a client library in various programming languages from the OpenAPI specification file that JsonApiDotNetCore APIs provide. For C# .NET clients generated using NSwag, we provide an additional package that introduces support for sending partial write requests. | ||
|
|
||
| ## Installation | ||
|
|
||
| You are required to install the following NuGet packages: | ||
|
|
||
| - `JsonApiDotNetCore.OpenApiClient` | ||
| - `NSwag.ApiDescription.Client` | ||
| - `Microsoft.Extensions.ApiDescription.Cient` | ||
| - `NSwag.ApiDescription.Client` | ||
|
|
||
| The following examples demonstrate how to install the `JsonApiDotNetCore.OpenApiClient` package. | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### CLI | ||
|
|
||
| ``` | ||
| dotnet add package JsonApiDotNetCore.OpenApiClient | ||
| ``` | ||
|
|
||
| ### Visual Studio | ||
|
|
||
| ```powershell | ||
| Install-Package JsonApiDotNetCore.OpenApiClient | ||
| ``` | ||
|
|
||
| ### *.csproj | ||
|
|
||
| ```xml | ||
| <ItemGroup> | ||
| <!-- Be sure to check NuGet for the latest version # --> | ||
| <PackageReference Include="JsonApiDotNetCore.OpenApiClient" Version="4.0.0" /> | ||
| </ItemGroup> | ||
| ``` | ||
|
|
||
|
|
||
| ## Adding an OpenApiReference | ||
|
|
||
| Add a reference to your OpenAPI specification in your project file as demonstrated below. | ||
|
|
||
| ```xml | ||
| <ItemGroup> | ||
| <OpenApiReference Include="swagger.json"> | ||
| <Namespace>JsonApiDotNetCoreExampleClient.GeneratedCode</Namespace> | ||
| <ClassName>ExampleApiClient</ClassName> | ||
| <CodeGenerator>NSwagCSharp</CodeGenerator> | ||
| <Options>/UseBaseUrl:false /GenerateClientInterfaces:true</Options> | ||
| </OpenApiReference> | ||
| </ItemGroup> | ||
| ``` | ||
|
|
||
|
|
||
| ## Usage | ||
|
|
||
| The NSwag tooling generates the OpenAPI client during a prebuild step. Once your application is built, | ||
| you can instantiate it using the class name as indicated in the project file. | ||
|
|
||
| ```c# | ||
| namespace JsonApiDotNetCoreExampleClient | ||
| { | ||
| class Program | ||
| { | ||
| static void Main(string[] args) | ||
| { | ||
| using (HttpClient httpClient = new HttpClient()) | ||
| { | ||
| ExampleApiClient exampleApiClient = new ExampleApiClient(httpClient); | ||
|
|
||
| // IntelliSense is now available on `exampleApiClient`! | ||
| } | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| Support for partial write requests can be enabled by leveraging the extensibility points of the generated client. | ||
|
|
||
| ```c# | ||
| namespace JsonApiDotNetCoreExampleClient.GeneratedCode | ||
| { | ||
| // Note that this class should be in the same namespace as the ExampleApiClient generated by NSwag. | ||
| public partial class ExampleApiClient : JsonApiClient | ||
| { | ||
| partial void UpdateJsonSerializerSettings(JsonSerializerSettings settings) | ||
| { | ||
| SetSerializerSettingsForJsonApi(settings); | ||
| } | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| You can now perform a write request by calling the `RegisterAttributesForRequest` method. Calling this method treats all attributes that contain their default value (<c>null</c> for reference types, <c>0</c> for integers, <c>false</c> for booleans, etc) as omitted unless explicitly listed to include them using the `alwaysIncludedAttributeSelectors` parameter. | ||
|
|
||
| ```c# | ||
| // Program.cs | ||
| static void Main(string[] args) | ||
| { | ||
| using (HttpClient httpClient = new HttpClient()) | ||
| { | ||
| ExampleApiClient exampleApiClient = new ExampleApiClient(httpClient); | ||
|
|
||
| var requestDocument = new PersonPatchRequestDocument | ||
| { | ||
| Data = new PersonDataInPatchRequest | ||
| { | ||
| Id = "546", | ||
| Type = PersonResourceType.People, | ||
| Attributes = new PersonAttributesInPatchRequest | ||
| { | ||
| FirstName = "Jack" | ||
| } | ||
| } | ||
| }; | ||
|
|
||
| using (apiClient.RegisterAttributesForRequestDocument<PersonPatchRequestDocument, PersonDataInPatchRequest>(requestDocument, person => person.LastName) | ||
| { | ||
| await exampleApiClient.PatchPersonAsync(543, requestDocument)); | ||
|
|
||
| // The request will look like this: | ||
| // | ||
| // { | ||
| // "data": { | ||
| // "type": "people", | ||
| // "id": "543", | ||
| // "attributes": { | ||
| // "firstName": "Jack", | ||
| // "lastName": null, | ||
| // } | ||
| // } | ||
| // } | ||
| } | ||
|
|
||
| } | ||
| } | ||
| ``` | ||
|
|
||
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
16 changes: 16 additions & 0 deletions
16
src/Examples/JsonApiDotNetCoreExampleClient/GeneratedCode/ExampleApiClient.cs
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,16 @@ | ||
| using JsonApiDotNetCore.OpenApiClient; | ||
| using Newtonsoft.Json; | ||
|
|
||
| namespace JsonApiDotNetCoreExampleClient.GeneratedCode | ||
| { | ||
| // ReSharper disable once MemberCanBeInternal | ||
| public partial class ExampleApiClient : JsonApiClient | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| partial void UpdateJsonSerializerSettings(JsonSerializerSettings settings) | ||
| { | ||
| SetSerializerSettingsForJsonApi(settings); | ||
|
|
||
| settings.Formatting = Formatting.Indented; | ||
| } | ||
| } | ||
| } | ||
9 changes: 9 additions & 0 deletions
9
src/Examples/JsonApiDotNetCoreExampleClient/GeneratedCode/IExampleApiClient.cs
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 @@ | ||
| using JsonApiDotNetCore.OpenApiClient; | ||
|
|
||
| namespace JsonApiDotNetCoreExampleClient.GeneratedCode | ||
| { | ||
| // ReSharper disable once MemberCanBeInternal | ||
| partial interface IExampleApiClient : IJsonApiClient | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| } | ||
| } | ||
31 changes: 31 additions & 0 deletions
31
src/Examples/JsonApiDotNetCoreExampleClient/JsonApiDotNetCoreExampleClient.csproj
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,31 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <OutputType>Exe</OutputType> | ||
| <TargetFramework>$(NetCoreAppVersion)</TargetFramework> | ||
| </PropertyGroup> | ||
|
|
||
| <ItemGroup> | ||
| <PackageReference Include="Newtonsoft.Json" Version="13.0.1" /> | ||
| <PackageReference Include="Microsoft.Extensions.ApiDescription.Client" Version="5.0.9"> | ||
| <PrivateAssets>all</PrivateAssets> | ||
| <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> | ||
| </PackageReference> | ||
| <PackageReference Include="NSwag.ApiDescription.Client" Version="13.13.2"> | ||
| <PrivateAssets>all</PrivateAssets> | ||
| <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets> | ||
| </PackageReference> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <OpenApiReference Include="swagger.json"> | ||
| <ClassName>ExampleApiClient</ClassName> | ||
| <CodeGenerator>NSwagCSharp</CodeGenerator> | ||
| <Namespace>JsonApiDotNetCoreExampleClient.GeneratedCode</Namespace> | ||
| <Options>/UseBaseUrl:false /GenerateClientInterfaces:true</Options> | ||
| </OpenApiReference> | ||
| </ItemGroup> | ||
|
|
||
| <ItemGroup> | ||
| <ProjectReference Include="..\..\JsonApiDotNetCore.OpenApiClient\JsonApiDotNetCore.OpenApiClient.csproj" /> | ||
| </ItemGroup> | ||
| </Project> |
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,36 @@ | ||
| using System; | ||
| using System.Net.Http; | ||
| using System.Threading.Tasks; | ||
| using JsonApiDotNetCoreExampleClient.GeneratedCode; | ||
|
|
||
| #pragma warning disable AV1210 // Catch a specific exception instead of Exception, SystemException or ApplicationException | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| namespace JsonApiDotNetCoreExampleClient | ||
| { | ||
| // ReSharper disable once ClassNeverInstantiated.Global | ||
| internal class Program | ||
bart-degreed marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| { | ||
| private static async Task Main() | ||
| { | ||
| using var httpClient = new HttpClient | ||
| { | ||
| BaseAddress = new Uri("http://localhost:14140") | ||
| }; | ||
|
|
||
| IExampleApiClient exampleApiClient = new ExampleApiClient(httpClient); | ||
|
|
||
| try | ||
| { | ||
| const int nonExistingId = int.MaxValue; | ||
| await exampleApiClient.Delete_personAsync(nonExistingId); | ||
| } | ||
| catch (ApiException exception) | ||
| { | ||
| Console.WriteLine(exception.Response); | ||
| } | ||
|
|
||
| Console.WriteLine("Press any key to close."); | ||
| Console.ReadKey(); | ||
| } | ||
| } | ||
| } | ||
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.