Rest API

Rules

1. Create API design before creating database queries

2. Adding meta infromation. Title, version (major, minor, patch), description, audience (218)

3. Security add: access-mode read, write (225)

Define:  new Claim("access_mode", AccessMode.Admin.ToString()),

Add: 

builder.Services.AddAuthorization(options => {

    options.AddPolicy("AdminOnly", policy =>    policy.RequireClaim("access_mode", AccessMode.Admin.ToString()));

Check: app.MapGet("/admin/stats", () => "ok")

   .RequireAuthorization("AdminOnly");

4. Standard format date time (169)

   1. UTC without lcal offset 2015-05-28T14:07:17Z 

5. Plural resource name (134)

6. Main sub resources (146)

/customers

/customers/{id}

/customers/{id}/preferences

/customers/{id}/addresses

/customers/{id}/addresses/{addr}

/addresses

/addresses/{addr}

7. Query parameters (137)

   1. q: parameter

   2. sort: + asc or - desc   -id 

8. Snake ase property names (118)

   1. customer_number, sales_order_number

9. Versioning (114 - 115)

   1. URI path: http://www.example.com/api/v1/products 

   2. Query parameters: http://www.example.com/api/products?version=1 

   3. Custom Headers: http://localhost:8080/api/products Headers: X-API-VERSION=1 

   4. Content Negotiation: http://localhost:8080/api/products Headers: Accept=application/vnd.javaguides-v1+json 

10. Before shut down Deprecation: <timestamp> 

11. Provide uniqie event identifiers (211)