Fixed links in docs

This commit is contained in:
Jonas Dellinger 2020-06-05 13:35:21 +02:00
parent 12bdeb1592
commit ca436c3099
7 changed files with 23 additions and 10 deletions

View File

@ -2,4 +2,7 @@
"editor.detectIndentation": false, "editor.detectIndentation": false,
"editor.insertSpaces": true, "editor.insertSpaces": true,
"editor.tabSize": 2, "editor.tabSize": 2,
"files.associations": {
"*.md": "mdx"
},
} }

View File

@ -3,6 +3,8 @@ id: auth_introduction
title: Introduction title: Introduction
--- ---
import useBaseUrl from '@docusaurus/useBaseUrl';
Spotify does not allow unauthorized access to the api. Thus, you need an access token to make requets. This access token can be gathered via multiple schemes, all following the OAuth2 spec. Since it's important to choose the correct scheme for your usecase, make sure you have a grasp of the following terminology/docs: Spotify does not allow unauthorized access to the api. Thus, you need an access token to make requets. This access token can be gathered via multiple schemes, all following the OAuth2 spec. Since it's important to choose the correct scheme for your usecase, make sure you have a grasp of the following terminology/docs:
* OAuth2 * OAuth2
@ -17,4 +19,4 @@ Then, continue with the docs of the specific auth flows:
* [Authorization Code](authorization_code.md) * [Authorization Code](authorization_code.md)
* [Token Swap](token_swap.md) * [Token Swap](token_swap.md)
![auth comparison](/img/auth_comparison.png) <img alt="auth comparison" src={useBaseUrl('img/auth_comparison.png')} />

View File

@ -3,6 +3,8 @@ id: example_asp
title: ASP.NET title: ASP.NET
--- ---
import useBaseUrl from '@docusaurus/useBaseUrl';
## Description ## Description
This example is based on ASP .NET Core. It uses `Authorization Code` under the hood with the help of [`AspNet.Security.OAuth.Spotify`](https://www.nuget.org/packages/AspNet.Security.OAuth.Spotify/). It stores the access token in the current user session (cookie-based) and allows to refresh tokens when they expire. Two pages are implemented: This example is based on ASP .NET Core. It uses `Authorization Code` under the hood with the help of [`AspNet.Security.OAuth.Spotify`](https://www.nuget.org/packages/AspNet.Security.OAuth.Spotify/). It stores the access token in the current user session (cookie-based) and allows to refresh tokens when they expire. Two pages are implemented:
@ -10,8 +12,8 @@ This example is based on ASP .NET Core. It uses `Authorization Code` under the h
* Home shows your current playlists via pagination * Home shows your current playlists via pagination
* Profile shows your current profile information * Profile shows your current profile information
![ASP Example - Home](/img/asp_example_home.png) <img alt="ASP Example - Home" src={useBaseUrl('img/asp_example_home.png')} />
![ASP Example - Profile](/img/asp_example_profile.png) <img alt="ASP Example - Profile" src={useBaseUrl('img/asp_example_profile.png')} />
## Run it ## Run it

View File

@ -3,11 +3,13 @@ id: example_blazor
title: Blazor ServerSide title: Blazor ServerSide
--- ---
import useBaseUrl from '@docusaurus/useBaseUrl';
## Description ## Description
Very similar to the [Blazor WASM Example](example_blazor_wasm.md), but runs code on the server side and pushes view updates to the client. Very similar to the [Blazor WASM Example](example_blazor_wasm.md), but runs code on the server side and pushes view updates to the client.
![ASP Blazor Example - Home](/img/asp_blazor_example_home.png) <img alt="ASP Blazor Example - Home" src={useBaseUrl('img/asp_blazor_example_home.png')} />
## Run it ## Run it

View File

@ -3,15 +3,16 @@ id: example_blazor_wasm
title: Blazor WASM title: Blazor WASM
--- ---
import useBaseUrl from '@docusaurus/useBaseUrl';
## Description ## Description
This small cross-platform web app runs on `Blazor WebAssembly`, which was released on 19. May 2020. It allows to run C# code in any browser which supports WebAssembly. This allows to create .NET full-stack web projects without writing any JavaScript. Find more about [Blazor WebAssembly here](https://devblogs.microsoft.com/aspnet/blazor-webassembly-3-2-0-now-available/) This small cross-platform web app runs on `Blazor WebAssembly`, which was released on 19. May 2020. It allows to run C# code in any browser which supports WebAssembly. This allows to create .NET full-stack web projects without writing any JavaScript. Find more about [Blazor WebAssembly here](https://devblogs.microsoft.com/aspnet/blazor-webassembly-3-2-0-now-available/)
Since this library is compatible with `.NET Standard 2.1`, you can use all features of `SpotifyAPI.Web` in your blazor wasm app. The example logs the user in via `Implicit Grant` and does 2 user-related API requests from the browser. You can observe the requests from your browsers network tools. Since this library is compatible with `.NET Standard 2.1`, you can use all features of `SpotifyAPI.Web` in your blazor wasm app. The example logs the user in via `Implicit Grant` and does 2 user-related API requests from the browser. You can observe the requests from your browsers network tools.
![BlazorWASM Spotify Example](/img/blazorwasm_homepage.png) <img alt="BlazorWASM Spotify Example" src={useBaseUrl('img/blazorwasm_homepage.png')} />
<img alt="BlazorWASM Spotify Example - network tools" src={useBaseUrl('img/blazorwasm_network_tools.png')} />
![BlazorWASM Spotify Example - network tools](/img/blazorwasm_network_tools.png)
## Run it ## Run it

View File

@ -3,6 +3,8 @@ id: implicit_grant
title: Implicit Grant title: Implicit Grant
--- ---
import useBaseUrl from '@docusaurus/useBaseUrl';
> Implicit grant flow is for clients that are implemented entirely using JavaScript and running in the resource owners browser. You do not need any server-side code to use it. Rate limits for requests are improved but there is no refresh token provided. This flow is described in RFC-6749. > Implicit grant flow is for clients that are implemented entirely using JavaScript and running in the resource owners browser. You do not need any server-side code to use it. Rate limits for requests are improved but there is no refresh token provided. This flow is described in RFC-6749.
This flow is useful for getting a user access token for a short timespan This flow is useful for getting a user access token for a short timespan
@ -35,7 +37,7 @@ Note, this parameter is not sent to the server! You need JavaScript to access it
This flow can also be used with custom protocols instead of `http`/`https`. This is especially interesting for `UWP` apps, since your able to register custom protocol handlers quite easily. This flow can also be used with custom protocols instead of `http`/`https`. This is especially interesting for `UWP` apps, since your able to register custom protocol handlers quite easily.
![protocol handlers](/img/auth_protocol_handlers.png) <img alt="protocol handlers" src={useBaseUrl('img/auth_protocol_handlers.png')} />
The process is very similar, you generate a uri and open it for the user The process is very similar, you generate a uri and open it for the user

View File

@ -3,6 +3,8 @@ id: proxy
title: Proxy title: Proxy
--- ---
import useBaseUrl from '@docusaurus/useBaseUrl';
The included `HTTPClient` has full proxy configuration support: The included `HTTPClient` has full proxy configuration support:
```csharp ```csharp
@ -21,5 +23,4 @@ var spotify = new SpotifyClient(config);
As an example, [mitmproxy](https://mitmproxy.org/) can be used to inspect the requests and responses: As an example, [mitmproxy](https://mitmproxy.org/) can be used to inspect the requests and responses:
![mitmproxy](/img/mitmproxy.png) <img alt="mitmproxy" src={useBaseUrl('img/mitmproxy.png')} />