Shulou(Shulou.com)06/03 Report--

Open the project

Open the ASP.NET Core application in Visual Studio 2019.

Add an API controller

Right-click the project and add a new folder named Api. Then, right-click the folder and select Add > New Scaffolded Item. Use Entity Framework to select an API Controller with an action. Now select an existing model class and click Add.

View the generated controller

The generated code includes a new controller class. At the top of the class definition are two properties.

[Route ("api/ [controller]")] [ApiController] public class GamesController: ControllerBase

The first route that specifies the action in this controller is api/ [controller], which means that if the controller name is GamesController, the route is api/Games.

The second property, [ApiController], adds some useful validation to the class, such as ensuring that each action method contains its own [Route] property.

Public class GamesController: ControllerBase {private readonly AppDbContext _ context; public GamesController (AppDbContext context) {_ context = context;}

The controller uses the existing AppDbContext and passes it to its constructor. Each operation will use this field to process the application's data.

/ / GET: api/ Gams [HttpGet] public IEnumerable GetGame () {return _ context.Game;}

The first method is to use a simple GET request specified by the [HttpGet] attribute. It takes no parameters and returns a list of all game in the database.

/ GET: api/Games/5 [HttpGet ("{id}")] public async Task GetGame ([FromRoute] int id) {if (! ModelState.IsValid) {return BadRequest (ModelState);} var game = await _ context.Game.FindAsync (id); if (game = = null) {return NotFound ();} return Ok (game);}

The next method specifies {id} in the route, which will be added to the route after /, so the complete route will be similar to api/Games/5, as shown in the comment at the top. The id input is mapped to the id parameter on the method. Inside the method, a BadRequest result is returned if the model is invalid. Download VS 2019 otherwise, EF will try to find a record that matches the id provided. If it cannot be found, the NotFound result is returned, otherwise the corresponding game record is returned.

/ / PUT: api/Games/5 [HttpPut ("{id}")] public async Task PutGame ([FromRoute] int id, [FromBody] Game game) {if (! ModelState.IsValid) {return BadRequest (ModelState);} if (id! = game.Id) {return BadRequest ();} _ context.Entry (game). State = EntityState.Modified; try {await _ context.SaveChangesAsync () } catch (DbUpdateConcurrencyException) {if (! GameExists (id)) {return NotFound ();} else {throw;}} return NoContent ();}

Next, use the request for API from [HttpPut] to perform the update. The new Game record is provided in the body of the request. Perform some validation and error checking, and if all goes well, the records in the database will be updated with the values provided in the request body. Otherwise, the appropriate error response will be returned.

/ / POST: api/ Gams [HttpPost] public async Task PostGame ([FromBody] Game game) {if (! ModelState.IsValid) {return BadRequest (ModelState);} _ context.Game.Add (game); await _ context.SaveChangesAsync (); return CreatedAtAction ("GetGame", new {id = game.Id}, game);}

A [HttpPost] request is used to add a new record to the system. Like [HttpPut], the record is added to the body of the request. If valid, EF Core adds the record to the database, and the operation returns the updated record (with the database-generated ID) and a link to the API record.

/ / DELETE: api/Games/5 [HttpDelete ("{id}")] public async Task DeleteGame ([FromRoute] int id) {if (! ModelState.IsValid) {return BadRequest (ModelState);} var game = await _ context.Game.FindAsync (id); if (game = = null) {return NotFound ();} _ context.Game.Remove (game); await _ context.SaveChangesAsync (); return Ok (game);}

Finally, [HttpDelete] uses a route with ID to delete the record. If the request is valid and there is a record with the given ID, EF Core deletes it from the database.

Add Swagger

Swagger is an API documentation and testing tool that can be added to ASP.NET Core applications as a set of services and middleware. To do this, right-click the project, and then select Manage NuGet Packages. Click Browse, search for Swashbuckle.AspNetCore, and install the appropriate package.

After installation, open Startup.cs and add the following to the end of the ConfigureServices method:

Services.AddSwaggerGen (c = > {c.SwaggerDoc ("v1", new Info {Title = "My API", Version = "v1"});})

At the same time, you need to add Swashbuckle.AspNetCore.Swagger to the top of the file.

Next, before UseMvc, add the following to the Configure method:

/ / Enable middleware to serve generated Swagger as a JSON endpoint.app.UseSwagger (); / / Enable middleware to serve swagger-ui (HTML, JS, CSS, etc.), / / specifying the Swagger JSON endpoint.app.UseSwaggerUI (c = > {c.SwaggerEndpoint ("/ swagger/v1/swagger.json", "My API V1");})

You should now be able to build and run the application.

In the browser, navigate to the / swagger address bar, and you should see a list of API endpoints and models for the application.

Click on an endpoint under Games, try to execute it, and see the behavior of different endpoints.

Welcome to subscribe "Shulou Technology Information " to get latest news, interesting things and hot topics in the IT industry, and controls the hottest and latest Internet news, technology news and IT industry trends.