review feedback

Author: maurei

docs/getting-started/install.md

@@ -19,6 +19,6 @@ Install-Package JsonApiDotnetCore
 ```xml
 <ItemGroup>
   <!-- Be sure to check NuGet for the latest version # -->
-  <PackageReference Include="JsonApiDotnetCore" Version="4.0.0" />
+  <PackageReference Include="JsonApiDotNetCore" Version="4.0.0" />
 </ItemGroup>
 ```

docs/usage/extensibility/middleware.md

@@ -27,7 +27,7 @@ public class Startup
     {
         services.AddSingleton<CustomAsyncQueryStringActionFilter>();
 
-        IMvcCoreBuilder builder = services.AddMvcCore();
+        IMvcCoreBuilder mvcBuilder = services.AddMvcCore();
         services.AddJsonApi<AppDbContext>(mvcBuilder: builder);
 
         // Ensure this call is placed after the AddJsonApi call.

docs/usage/openapi.md

@@ -4,26 +4,26 @@ You can describe your API with an OpenAPI specification using the [Swashbuckle](
 
 ## Installation
 
-Install the `JsonApiDotnetCore.OpenApi` NuGet package.
+Install the `JsonApiDotNetCore.OpenApi` NuGet package.
 
 ### CLI
 
 ```
-dotnet add package JsonApiDotnetCore.OpenApi
+dotnet add package JsonApiDotNetCore.OpenApi
 ```
 
 ### Visual Studio
 
 ```powershell
-Install-Package JsonApiDotnetCore.OpenApi
+Install-Package JsonApiDotNetCore.OpenApi
 ```
 
 ### *.csproj
 
 ```xml
 <ItemGroup>
   <!-- Be sure to check NuGet for the latest version # -->
-  <PackageReference Include="JsonApiDotnetCore.OpenApi" Version="4.0.0" />
+  <PackageReference Include="JsonApiDotNetCore.OpenApi" Version="4.0.0" />
 </ItemGroup>
 ```
 
@@ -58,7 +58,7 @@ public class Startup
 
 By default, the OpenAPI specification will be available at `http://localhost:<port>/swagger/v1/swagger.json`.
 
-Swashbuckle also ships with [SwaggerUI](https://swagger.io/tools/swagger-ui/), tooling for a generated documentation page. This can be enabled by adding the following to your `Startup` class. 
+Swashbuckle also ships with [SwaggerUI](https://swagger.io/tools/swagger-ui/), tooling for a generated documentation page. This can be enabled by installing the `Swashbuckle.AspNetCore.SwaggerUI` NuGet package and adding the following to your `Startup` class.
 
 ```c#
 // Startup.cs

docs/usage/toc.md

@@ -21,6 +21,7 @@
 # [Errors](errors.md)
 # [Metadata](meta.md)
 # [Caching](caching.md)
+# [OpenAPI](openapi.md)
 
 # Extensibility
 ## [Layer Overview](extensibility/layer-overview.md)
@@ -31,4 +32,3 @@
 ## [Middleware](extensibility/middleware.md)
 ## [Query Strings](extensibility/query-strings.md)
 
-# [OpenAPI](openapi.md)

src/Examples/JsonApiDotNetCoreExample/Startup.cs

@@ -47,8 +47,6 @@ public void ConfigureServices(IServiceCollection services)
 
                 IMvcCoreBuilder mvcBuilder = services.AddMvcCore();
 
-                services.AddOpenApi(mvcBuilder);
-
                 using (CodeTimingSessionManager.Current.Measure("Configure JSON:API (startup)"))
                 {
                     services.AddJsonApi<AppDbContext>(options =>
@@ -64,6 +62,8 @@ public void ConfigureServices(IServiceCollection services)
 #endif
                     }, discovery => discovery.AddCurrentAssembly(), mvcBuilder: mvcBuilder);
                 }
+
+                services.AddOpenApi(mvcBuilder);
             }
         }
 
@@ -82,14 +82,14 @@ public void Configure(IApplicationBuilder app, IWebHostEnvironment environment,
 
                 app.UseRouting();
 
-                app.UseSwagger();
-                app.UseSwaggerUI();
-
                 using (CodeTimingSessionManager.Current.Measure("Initialize JSON:API (startup)"))
                 {
                     app.UseJsonApi();
                 }
 
+                app.UseSwagger();
+                app.UseSwaggerUI();
+
                 app.UseEndpoints(endpoints => endpoints.MapControllers());
             }
 

src/JsonApiDotNetCore.OpenApi/ServiceCollectionExtensions.cs

@@ -6,14 +6,14 @@ namespace JsonApiDotNetCore.OpenApi
 {
     public static class ServiceCollectionExtensions
     {
-        public static void AddOpenApi(this IServiceCollection services, IMvcCoreBuilder builder, Action<SwaggerGenOptions> setupSwaggerGenAction = null)
+        public static void AddOpenApi(this IServiceCollection services, IMvcCoreBuilder mvcBuilder, Action<SwaggerGenOptions> setupSwaggerGenAction = null)
         {
             ArgumentGuard.NotNull(services, nameof(services));
-            ArgumentGuard.NotNull(builder, nameof(builder));
+            ArgumentGuard.NotNull(mvcBuilder, nameof(mvcBuilder));
 
-            builder.AddApiExplorer();
+            mvcBuilder.AddApiExplorer();
 
-            builder.AddMvcOptions(options => options.Conventions.Add(new OpenApiEndpointConvention()));
+            mvcBuilder.AddMvcOptions(options => options.Conventions.Add(new OpenApiEndpointConvention()));
 
             services.AddSwaggerGen(setupSwaggerGenAction);
         }