review feedback

Author: maurei

docs/usage/openapi.md

@@ -36,11 +36,11 @@ public class Startup
 {
     public void ConfigureServices(IServiceCollection services)
     {
-        IMvcCoreBuilder builder = services.AddMvcCore();
-        services.AddJsonApi<AppDbContext>(mvcBuilder: builder);
+        IMvcCoreBuilder mvcBuilder = services.AddMvcCore();
+        services.AddJsonApi<AppDbContext>(mvcBuilder: mvcBuilder);
 
 	    // Adds the Swashbuckle integration.
-	    services.AddOpenApi(builder);
+	    services.AddOpenApi(mvcBuilder);
     }
 
     public void Configure(IApplicationBuilder app, IWebHostEnvironment env)

src/Examples/JsonApiDotNetCoreExample/JsonApiDotNetCoreExample.csproj

@@ -4,8 +4,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\JsonApiDotNetCore.OpenApi\JsonApiDotNetCore.OpenApi.csproj" />
     <ProjectReference Include="..\..\JsonApiDotNetCore\JsonApiDotNetCore.csproj" />
+    <ProjectReference Include="..\..\JsonApiDotNetCore.OpenApi\JsonApiDotNetCore.OpenApi.csproj" />
   </ItemGroup>
 
   <ItemGroup>

src/Examples/JsonApiDotNetCoreExample/Startup.cs

@@ -45,9 +45,9 @@ public void ConfigureServices(IServiceCollection services)
 #endif
                 });
 
-                IMvcCoreBuilder mvcCoreBuilder = services.AddMvcCore();
+                IMvcCoreBuilder mvcBuilder = services.AddMvcCore();
 
-                services.AddOpenApi(mvcCoreBuilder);
+                services.AddOpenApi(mvcBuilder);
 
                 using (CodeTimingSessionManager.Current.Measure("Configure JSON:API (startup)"))
                 {
@@ -62,7 +62,7 @@ public void ConfigureServices(IServiceCollection services)
 #if DEBUG
                         options.IncludeExceptionStackTraceInErrors = true;
 #endif
-                    }, discovery => discovery.AddCurrentAssembly(), mvcBuilder: mvcCoreBuilder);
+                    }, discovery => discovery.AddCurrentAssembly(), mvcBuilder: mvcBuilder);
                 }
             }
         }

test/OpenApiTests/OpenApiDocumentTests.cs

@@ -21,9 +21,9 @@ public OpenApiDocumentTests()
         public async Task Retrieved_document_matches_expected_document()
         {
             // Arrange
-            string embeddedResourceName = $"{nameof(OpenApiTests)}.openapi.json";
+            string embeddedResourceName = $"{nameof(OpenApiTests)}.swagger.json";
             string expectedDocument = await LoadEmbeddedResourceAsync(embeddedResourceName);
-            string requestUrl = $"swagger/{OpenApiStartup<OpenApiDbContext>.OpenApiDocumentName}/swagger.json";
+            string requestUrl = "swagger/v1/swagger.json";
 
             // Act
             string actualDocument = await GetAsync(requestUrl);

test/OpenApiTests/OpenApiStartup.cs

@@ -5,27 +5,20 @@
 using Microsoft.EntityFrameworkCore;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
-using Microsoft.OpenApi.Models;
 using TestBuildingBlocks;
 
 namespace OpenApiTests
 {
     public sealed class OpenApiStartup<TDbContext> : TestableStartup<TDbContext>
         where TDbContext : DbContext
     {
-        internal const string OpenApiDocumentName = nameof(OpenApiTests);
-
         public override void ConfigureServices(IServiceCollection services)
         {
-            IMvcCoreBuilder mvcCoreBuilder = services.AddMvcCore();
+            IMvcCoreBuilder mvcBuilder = services.AddMvcCore();
 
-            services.AddJsonApi<TDbContext>(SetJsonApiOptions, mvcBuilder: mvcCoreBuilder);
+            services.AddJsonApi<TDbContext>(SetJsonApiOptions, mvcBuilder: mvcBuilder);
 
-            services.AddOpenApi(mvcCoreBuilder, options => options.SwaggerDoc(OpenApiDocumentName, new OpenApiInfo
-            {
-                Title = OpenApiDocumentName,
-                Version = "1"
-            }));
+            services.AddOpenApi(mvcBuilder);
         }
 
         public override void Configure(IApplicationBuilder app, IWebHostEnvironment environment, ILoggerFactory loggerFactory)

test/OpenApiTests/OpenApiTests.csproj

@@ -15,13 +15,13 @@
     </ItemGroup>
 
     <ItemGroup>
-      <EmbeddedResource Include="openapi.json" />
+      <EmbeddedResource Include="swagger.json" />
     </ItemGroup>
 
     <!-- Fixes IntelliSense errors on openapi.json in Visual Studio 2019, which uses the schema for OpenAPI 3.1 by default. -->
     <ProjectExtensions>
         <VisualStudio>
-            <UserProperties integrationtests_4openapi_1json__JsonSchema="https://github.com/raw/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json" />
+            <UserProperties swagger_1json__JsonSchema="https://github.com/raw/OAI/OpenAPI-Specification/main/schemas/v3.0/schema.json" />
         </VisualStudio>
     </ProjectExtensions>
 </Project>