Nebol's Wiki

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
==== NebolController_Books_NETCore ====

This is a step-by-step example of building a ASP.NET Core Web application using NebolController 1.0.0.30

==== NOT DONE! WORK IN PROGRESS! ====

Create a new project using the "ASP.NET Core Web Application" template. Select the "API" version to get some basic scaffolding.
I am using .NET Core version is 3. I unchecked the "Configure for HTTPS" option. 

You will probably get a sample controller named WeatherForecastController.cs, feel free to delete that one, and in Project Properties --> Debug dialog replace the "weatherforecast" string in the "Launch Browser" editbox with "api/book". That will work later.

Add nuget packages

If you haven't done so already, add the nuget.nebol.se repository to Visual Studio by running this in Package Manager:

<code>nuget sources add -name nuget.nebol.se -source https://nuget.nebol.se/api/odata</code>

Then add the packages:

<code>Install-Package NebolBooks
Install-Package NebolController
Install-Package SharpRepository.Ioc.Microsoft.DependencyInjection
Install-Package AutoMapper.Extensions.Microsoft.DependencyInjection -version 6.1.1
Install-Package SharpRepository.InMemoryRepository
</code>

<nowiki>The reason for using version 6.1.1 of AutoMapper.Extensions.Microsoft.DependencyInjection is that the next version (7.0.0) uses AutoMapper 9, and NebolController is not configured to work with 9, only with 8.</nowiki>

<code>
Install-Package Autofac.Extensions.DependencyInjection -version 5.0.1
Install-Package SharpRepository.Ioc.Autofac
</code>

<nowiki>The reason for using version 5.0.1 of Autofac.Extensions.DependencyInjection is that the next version 6.0.0 uses AutoFac >= 5.0.0 and SharpRepository.Ioc.Autofac 2.1.0-prerelease requires AutoFac < 5.0.0</nowiki>



We'll add some view models
<code>add code</code>

Add a BookRepositoryHelper that gets the books from NebolBooks and loads them into the in-memory repository.
<code>add code</code>

Add specifications
<code>add code</code>

Add profile
<code>add code</code>

Add controller

Add SharpRepository setup in app.settings

Changes to Startup.ConfigureServices:

change return type from void to IServiceProvider
services.AddAutoMapper...
return services.UseSharpRepository(Configuration.GetSection("sharpRepository"));

additions to Configure()...

As this is a .NET Core 3.1 application we need to add a supported DI package and do the steps described here:
https://github.com/SharpRepository/SharpRepository/wiki/Getting-started
in the section titled "ASP.NET Core 3.0 Applications"


----

You know what? Let's add some finishing touches.

=== Response compression ===

In Startup.ConfigureServices() add
<code csharp>
services.AddResponseCompression();
</code>

In Startup.Configure() add
<code csharp>
app.UseResponseCompression();
</code>

=== Swagger ===

Taken from here:
[[https://docs.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-swashbuckle?view=aspnetcore-3.1&tabs=visual-studio|Get started with Swashbuckle and ASP.NET Core]]

<code csharp>
Install-Package Swashbuckle.AspNetCore
</code>

<nowiki>In Startup.ConfigureServices() add</nowiki>
<code csharp>
services.AddSwaggerGen(c =>
{
	c.SwaggerDoc("v1", new OpenApiInfo { Title = "API", Version = "v1" });
});
</code>

<nowiki>In Startup.Configure(), perhaps inside "if (env.IsDevelopment())" add</nowiki>
<code csharp>
app.UseSwagger();

app.UseSwaggerUI(c =>
{
	c.SwaggerEndpoint("/swagger/v1/swagger.json", "API V1");
});
</code>

=== Pretty JSON Formatting ===

<nowiki>In Startup.ConfigureServices() add</nowiki>

For .NET Core 3.0+:
<code csharp>
services.AddMvc()
	.AddJsonOptions(options =>
	{
		options.JsonSerializerOptions.WriteIndented = true;    
		//options.SerializerSettings.Formatting = Formatting.Indented; // NewtonsoftJson
	});
</code>

Now try to run it, and visit /swagger to see the automatically generated API documentation!
Nebol's Wiki

User Tools

Site Tools

Page Tools
