Skip to content

Commit

Permalink
updated readmes.
Browse files Browse the repository at this point in the history
  • Loading branch information
VeritasSoftware committed Jul 28, 2024
1 parent 2227ea7 commit 32e9dcf
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 20 deletions.
6 changes: 2 additions & 4 deletions Docs/README_ConfigSettings.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
### Api Gateway Config Settings

You can keep the ApiKey, RouteKey, Backend API Base Url and Route Path,
You can keep the **ApiKey**, **RouteKey**, **Backend API Base Urls** and **Route Paths**,

in your appsettings.json file.

The **Identifier** is used to identify each **ApiSetting** & **RouteSetting**.

In your Gateway API project's appsettings.json file,

add a **Settings** section like shown below:
In your Gateway API project's appsettings.json file, add a **Settings** section like shown below:

```JSON
{
Expand Down
37 changes: 21 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,16 +91,6 @@ So, the call to the Gateway would become:

* **HTTP GET - /weatherservice/forecast**

**Using appsettings.json**

If you want, you can keep the **ApiKey, RouteKey, backend API base urls and Route path**,

in the **appsettings.json**, read it using a Config Service,

and pass it to the Api Orchestrator in the below Create method.

Read [**more**](/Docs/README_ConfigSettings.md).

**Add a reference to the package and...**

* Create an **Api Orchestration**.
Expand Down Expand Up @@ -215,19 +205,34 @@ you can enter the **Api key** and **Route key** into Swagger as below:

This will hit the **weatherforecast/forecast** endpoint on the backend Weather API.

You can check out how the Api Gateway supported Verbs are used below.
### Using appsettings.json

If you want, you can keep the **ApiKey, RouteKey, backend API base urls and Route path**,

in the **appsettings.json**, read it using a Config Service,

and pass it to the Api Orchestrator in the below Create method.

Read [**more**](/Docs/README_ConfigSettings.md).

### Verbs usage & Routing

You can check out how the Api Gateway supported Verbs are used & Routing below.

### [Verbs Usage & Routing](Docs/README_VERBS.md)

### Authorization

### [Verbs Usage](Docs/README_VERBS.md)
Just like a Web API's Authorization Filter, the framework provides a **Gateway Authorization Filter**.

You can check out how the Api Gateway's endpoint Authorization support below.
Here you can perform any kind of Authorization you like. There is no prescribed Authorization.

### [Authorization](Docs/README_Authorization.md)

### Customizations

* Customize the default **HttpClient** used by all the routes, to hit the backend Api.
* Customize the default HttpClient which each route uses to hit the backend Api.
* Use your own **HttpClient** for each route.
* Create a new or customize the default **HttpClient** used by all the routes, to hit the backend Api.
* Create a new or customize the default **HttpClient** which each route uses to hit the backend Api.
* Use your own custom implementation to hit the backend Api.

For **Request aggregation**, see this section.
Expand Down

0 comments on commit 32e9dcf

Please sign in to comment.