Merge pull request #51 from Minimal-APIs/quickstart

Updated the tutorial

Author: LadyNaggaga

src/.vuepress/config.js

@@ -46,6 +46,10 @@ module.exports = {
         text: "Quickstart",
         link: "/quickstart/",
       },
+      {
+        text: "Guide",
+        link: "/guide/",
+      },
       {
         text: "Tutorial",
         link: "/tutorial/",
@@ -63,7 +67,7 @@ module.exports = {
     sidebar: {
       "/tutorial/": [
         {
-          title: "Guide",
+          title: "Tutorial",
           collapsable: false,
           children: ["", "first-steps", "crud", "databases"],
         },
@@ -75,6 +79,13 @@ module.exports = {
           children: ["", "quickstart"],
         },
       ],
+      "/guide/": [
+        {
+          title: "Guide",
+          collapsable: true,
+          children: ["", "routing" , "static_assets" , "database" , "validation" , "error_handling" , "middleware" , "authentication" , "deployment", "dependency_injection","openapi", ],
+        },
+      ],
     },
   },
 

src/index.md

@@ -37,3 +37,27 @@ Minimal routes by design. Create meaningful low ceremony URLs that execute your
 ```csharp
 app.MapGet("/", () => "Hello World!");
 ```
+### Feels familiar
+
+Minimal code patterns have been popular in JavaScript and Python web frameworks for a while. Whether you are familiar with Express or Flask, we think you can easily do things you enjoy about those frameworks with minimal APIs as well. 
+
+**For example**
+
+Routes in Express 
+```JS
+// GET method route
+app.get('/', function (req, res) {
+  res.send('GET request to the homepage')
+})
+
+// POST method route
+app.post('/', function (req, res) {
+  res.send('POST request to the homepage')
+})
+```
+Routes in minimal APIs 
+```csharp
+app.MapGet("/", () => "GET request to the homepage");
+app.MapPost("/", () => "POST request to the homepage");
+```
+

src/quickstart/grpc.md

@@ -1,4 +1,15 @@
-# Tutorial
+# Tutorials
 
-## Tutorial scenario 
-![WIP](https://user-images.githubusercontent.com/2546640/130136817-6389ec08-89dd-4ab2-83cd-3ab9644fb0c0.gif)
+Minimal APIs tutorials are here to teach you how to build your very first C# application. 
+
+### Tutorial One:  CRUD and minimal APIs. 
+
+This tutorial will teach you how to build the backend to a Todo App using minimal APIs. By the end of this tutorial, you will know how: 
+- Create a minimal API
+- Build interactive API documentation with Swagger UI 
+- Build CRUD application 
+- Store Todo items into a database.
+
+### Tutorial Two:  Connect your minimal API to Web UI 
+
+In this tutorial, you will learn how to connect to a frontend framework of your choice.

src/quickstart/mlnet.md

@@ -1,7 +1,7 @@
-# Let's build
+# Let's build 
 ## Create Read Update Delete
 
-In checklist one, you built simple API where you hardcoded the results to HTTP method.
+In [checklist one ](/tutorial/first-steps), you built simple API where you hard coded the results to HTTP method. 
 
 For example:  `app.MapGet("/todo", () => new { Item = "Water plants", Complete = "false" });`  has been hard coded to return the JSON results below.
 
@@ -12,21 +12,18 @@ For example:  `app.MapGet("/todo", () => new { Item = "Water plants", Complete =
 }
 ```
 
-In checklist 2, you are going to step it up a notch and create something dynamic. Instead of returning a static item that is hardcoded to your route, you are going to be creating to-do list you can update, create new items, mark an item as complete, and delete an item.
-
-### Learn checklist Two ✔️
+In checklist 3 we are going to step it up a notch and create something dynamic. Instead of returning a static item that is hardcoded to our route, we are going to be creating to-do list we can update, create new items, mark an item as complete and delete an item. 
 
 Our to-do APIs is going to:
-
 - Create a new item.➕
 - Return a specific item on a list.  :leftwards_arrow_with_hook:
 - Update an existing item. :arrows_counterclockwise:
 - Delete an item. ➖
 
-Create a class that models the data you want to collect, that is, Data model. The code for your `TodoItem` will go after `app.Run();`
 
-**Create a data model**
+Create a class that models the data we want to collect aka Data model. The code for your `TodoItem` will go after `app.Run();`
 
+**Create a data model** 
 ```cs
 class TodoItem
 {
@@ -36,43 +33,34 @@ class TodoItem
 
 }
 ```
+Now, that we have defined that data we want to collect we need to save it. 
 
-Now that you've defined the data you want to collect, you need to save it.
+**Store an item** 
 
-**Store an item**
+To store the items in the to do list we are going need to install  the Entity Frameworkcore InMemomry package below.
 
-To store the items in the to do list, install the Entity Framework Core InMemomry package as shown below.
+> *What is Entity Framework?*  is a code library that enables the transfer of data stored in relational database tables(E.g. SQLite and MySQL, SQL server etc) into objects that are more commonly used in application code. 
 
-*What is Entity Framework (EF)?* EF is a code library that enables the transfer of data stored in relational database tables (such as, SQLite,  MySQL, and SQL Server) into objects that are more commonly used in application code.
 
 **Using .NET CLI**
 
-In your terminal window:
-
+In your terminal window
 ```console
 TodoApi>dotnet add package Microsoft.EntityFrameworkCore.InMemory --version 5.0.7
 ```
-
-**In Visual Studio**
-
-In Visual Studio, you can use the Package Manager Console or Manager Nuget Package GUI.
-
-```console
-PM>Install-Package Microsoft.EntityFrameworkCore.InMemory -Version 5.0.7
-```
-
+ 
 Add `using Microsoft.EntityFrameworkCore;` to the top of your `Program.cs` file.
 
-Now that you have Entity Framework, you can wire up your code to the data you want to save and query. To do this, create a `TodoDb` class. This class is going to do the following:
+Now, that we have EntityFramework we can now wire up our code to the data we want save and query it. To do this we are going to create a `TodoDb` class. `TodoDb` class is going to do the following:
 
-- Expose the `Todos` property from the list of `TodoItem` in the database.
-- `UseInMemoryDatabase` wires the in-memory database storage. This will store data as long the app is running.
+- Expose our `Todos` property from our list of `TodoItem` in the database.
+- `UseInMemoryDatabase` wires the in memory database storage.This will store data as long the app is running.
 
-To set up your in-memory database, add the following code snippets to your code.
+To setup your in memory database add the following code snippets to our code.
 
-**Snippet 1** : Below the `TodoItem`, create a `TodoDb` class:
+**Snippet 1** : Below the `TodoItem` create a `TodoDb` class 
 
-```cs
+```cs 
 class TodoDb : DbContext
 {
     public TodoDb(DbContextOptions options) : base(options) { }
@@ -84,54 +72,50 @@ class TodoDb : DbContext
     }
 }
 ```
+`DbContext` represents a connection/session which is used to query and save instances of entities in a database.
 
-`DbContext` represents a connection/session, which is used to query and save instances of entities in a database.
-
-**Snippet 2** : Before `AddSwaggerGen` services that you configured in the [first tutorial](first-steps.md#interactive-api-docs), add the following code snippet.
+**Snippet 2** : Before `AddSwaggerGen` services we configured in the [first tutorial](https://github.com/LadyNaggaga/minimal-apis-blog/blob/b5e97d3168b0948d8926afbd6dbc883cb32ba21a/Tutorials/Firststeps.md#interactive-api-docs) add the code snippet below.
 
 ``` cs
 builder.Services.AddDbContext<TodoDb>(options => options.UseInMemoryDatabase("items"));
 ```
+**Return a list of items** 
 
-**Return a list of items**
-
-To read from a list of items in the todo list, replace the "/todo" route with the "/todos" route below.
+To read from a list of items in the todo list replace  the "/todo" route with the "/todos" route below. 
 
  ``` cs
  app.MapGet("/todos", async (TodoDb db) => await db.Todos.ToListAsync());
  ```
 
-Go back your browser and navigate to `https://localhost:5001/swagger`. Click on the **GET**`/todos` button and you should see that the list is empty under `Response body`.
+Go back your browser and navigate to `https://localhost:5001/swagger` click on the **GET**`/todos` button and you will see the list is empty under `Response body`.
 
 ![swagger-get-todos](https://user-images.githubusercontent.com/2546640/125181126-af45d000-e1cf-11eb-82a8-4691bdb9deb9.gif)
 
-## Create new items
-
+## Create new items 
+ 
  Let's `POST` new tasks to the todos list. Below `app.MapGet` you create earlier.
 
-```cs
+```cs 
 app.MapPost("/todos", async (TodoDb db, TodoItem todo) =>
 {
     await db.Todos.AddAsync(todo);
     await db.SaveChangesAsync();
     return Results.Created($"/todo/{todo.Id}", todo);
 });
 ```
+Go back to `Swagger` and now you should see  **`POST`**`/todos`. To add new items to the todo list 
 
-Go back to `Swagger` and now you should see  **`POST`**`/todos`. To add new items to the todo list
-
-- Click on **`POST`** `/todos`
+- Click on **`POST`** `/todos` 
 - Click on `Try it out`
 - Update `id`, `item`, and `isComplete`
 - Click `Execute`
 
 ![swagger-post-todos](https://user-images.githubusercontent.com/2546640/125181715-b079fb80-e1d5-11eb-96e1-befc11ae8a0a.gif)
 
-**Read the items in the list**
-
-To read the items in the list:
+**Read the items in the list** 
 
-- Click on **`GET`**`/todos`
+To read the items in the list 
+- click on **`GET`**`/todos`
 - Click on `Try it out`
 - Click `Execute
 
@@ -151,27 +135,26 @@ The `Response body` will include the items just added.
   }
 ]
 ```
-
-To `GET` an item by `id`, add the following code under the `app.MapPost` route that you created earlier.
+To `GET` an item by `id` add the code below `app.MapPost` route created earlier 
 
 ```cs
 app.MapGet("/todos/{id}", async (TodoDb db, int id) => await db.Todos.FindAsync(id));
-```
 
-To check this out, you can go to `https://localhost:5001/todos/1` or use the swagger UI.
-![swagger-get-todos-item](https://user-images.githubusercontent.com/2546640/125182403-bd99e900-e1db-11eb-83bb-72eb89b4386f.gif)
+```
+To check this out you can either go to `https://localhost:5001/todos/1` or use the swagger UI.
+ ![swagger-get-todos-item](https://user-images.githubusercontent.com/2546640/125182403-bd99e900-e1db-11eb-83bb-72eb89b4386f.gif)
 
-## Update an item
+## Update an item 
 
-To update an existing item add the following code under the `GET /todos/{id}` route you created earlier.
+To update an existing item add the code below `GET /todos/{id}` route we created above.
 
-```cs
+```cs 
 app.MapPut("/todos/{id}", async ( TodoDb db, TodoItem updateTodo ,int id) =>
 {
     var todo = await db.Todos.FindAsync(id);
-
+    
     if (todo is null) return NotFound();
-
+    
     todo.Item = updateTodo.Item;
     todo.IsComplete = updateTodo.IsComplete;
 
@@ -180,29 +163,27 @@ app.MapPut("/todos/{id}", async ( TodoDb db, TodoItem updateTodo ,int id) =>
     return Results.NoContent();
 });
 ```
-
-- Click on **`PUT`**`/todos/{id}`.
-- Click on `Try it out`.
-- In the **`id`** text box, enter 2.
+- click on **`PUT`**`/todos/{id}`
+- Click on `Try it out`
+- In the **`id`** text box enter 2
 - Update `Request body` paste the JSON below and update `isComplete` to `true`.
-
 ``` json
  {
     "id": 2,
     "item": "Water plants",
     "isComplete": false
   }
-```
 
+```
 - Click `Execute`
 
-To test this, scroll back to **`GET`**`/todos/{id}` and now Water Plants is marked as complete.
+To test this out scroll back to **`GET`**`/todos/{id}` and now Water Plants is marked as complete.
 
 ![swagger-put-todos-item](https://user-images.githubusercontent.com/2546640/125183698-bdebb180-e1e6-11eb-80fd-c78c1ff01ea4.gif)
 
-## Delete an item
+## Delete an item.
 
-To delete an existing item, add the following code under **`PUT`**`/todos/{id}` that you created earlier.
+To delete an existing item add the code below **`PUT`**`/todos/{id}` we created above.
 
 ```cs
 app.MapDelete("/todos/{id}", async (TodoDb db, int id) =>
@@ -219,16 +200,16 @@ app.MapDelete("/todos/{id}", async (TodoDb db, int id) =>
 
 });
 ```
-
 Now, try deleting an item.
 ![swagger-delete-todos-item](https://user-images.githubusercontent.com/2546640/125184240-2daf6b80-e1ea-11eb-86db-6109bc04f700.gif)
 
-### Learn checklist one ✔️
 
-- Add model class and database context
-- CRUD methods
-  - `GET`:read an item.
-  - `POST`: create an item.
-  - `PUT`: update an item.
-  - `DELETE`: delete an item.
-- Configured routing and returned values
+ ### Learn checklist three ✔️   
+  
+ - Add model class and database context 
+  - CRUD methods
+      - `GET`:read an item.
+      - `POST`: create an item.
+      - `PUT`: update an item.
+      - `DELETE`: delete an item.
+ - Configured routing and returned values