You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A Live demo is available at **/ui** in all ServiceStack **v6+** Apps, e.g: [vue-vite-api.jamstacks.net/ui](https://vue-vite-api.jamstacks.net/ui)
14
+
A Live demo is available at **/ui** in all ServiceStack **v6+** Apps, e.g: [blazor-vue.web-templates.io/ui](https://blazor-vue.web-templates.io/ui)
15
15
:::
16
16
17
17
The entire API Explorer UI is driven by the **rich metadata** around your APIs typed Service Contracts and AppHost's **registered plugins**.
@@ -25,7 +25,7 @@ The entire API Explorer UI is driven by the **rich metadata** around your APIs t
25
25
26
26
If your AppHost has the ServiceStack [AuthFeature](/auth/authentication-and-authorization) plugin registered, the home page will display a **Sign In** dialog based on the its **configured Auth Providers**.
27
27
28
-
This is what you'll see in a new [Vue Vite](https://vue-vite-api.jamstacks.net/ui) project which has **Credentials** Auth, **JWT** as well as **Facebook**, **Google** and **Microsoft** OAuth providers registered in [Configure.Auth.cs](https://github.com/LegacyTemplates/blazor-wasm/blob/main/MyApp/Configure.Auth.cs)
28
+
This is what you'll see in a new [Vue Vite](https://blazor-vue.web-templates.io/ui) project which has **Credentials** Auth, **JWT** as well as **Facebook**, **Google** and **Microsoft** OAuth providers registered in [Configure.Auth.cs](https://github.com/LegacyTemplates/blazor-wasm/blob/main/MyApp/Configure.Auth.cs)
@@ -78,8 +78,7 @@ public class CustomCredentialsAuthProvider : CredentialsAuthProvider
78
78
79
79
Where the `Input` utility can be used to configure most HTML Form Input control properties that automatically configures to use the desired Input control for each property Type.
80
80
81
-
You can Sign In with any of the users in the [Vue Vite Sign In](https://vue-vite.jamstacks.net/signin) page configured in
You can Sign In with any of the users in the [Vue Vite Sign In](https://blazor-vue.web-templates.io/signin) page configured in `Configure.AuthRepository.cs`, i.e:
@@ -150,7 +149,7 @@ Control types are based on the property types in your DTOs.
150
149
|`<input type=checkbox>`| Boolean |
151
150
|`<input type=text>`| default |
152
151
153
-
Where the `CreateBooking` Request DTO defined in [Bookings.cs](https://github.com/LegacyTemplates/blazor-wasm/blob/main/MyApp.ServiceModel/Bookings.cs):
152
+
Where the `CreateBooking` Request DTO defined in [Bookings.cs](https://github.com/NetCoreTemplates/blazor-vue/blob/main/MyApp.ServiceModel/Bookings.cs):
154
153
155
154
```csharp
156
155
[Tag("bookings"), Description("Create a new Booking")]
@@ -176,7 +175,7 @@ public class CreateBooking : ICreateDb<Booking>, IReturn<IdResponse>
@@ -188,7 +187,7 @@ to further customize the Input UI control for each property as a **declarative a
188
187
API Form also supports auto binding [Argument Exceptions](/error-handling) or [Fluent](/validation) & [Declarative](/declarative-validation) Validation rules where any validation errors will be contextually displayed next to the invalid property. Here's both the resulting invalid UI & the Error Response DTO that generated it:
@@ -276,7 +275,7 @@ It includes the necessary steps to call your APIs from client Apps, following th
276
275
277
276
At which point without any code-gen or build tools, they'll end up with an Typed API configured to your APIs endpoint. E.g. this is what it looks like to **Python** developers:
@@ -300,7 +299,7 @@ To become the preferred solution to document APIs, API Explorer was designed fro
300
299
### API Annotations
301
300
302
301
Whilst the capability of adding rich API Docs is essential when needed, we expect plain C# attributes will often be used to document APIs where `[Description]` can be used to provide a short summary on a **Type** and its **Properties** whilst richer HTML markup can be added to any Type using `[Notes]`
303
-
as done in [Bookings.cs](https://github.com/LegacyTemplates/blazor-wasm/blob/main/MyApp.ServiceModel/Bookings.cs):
302
+
as done in [Bookings.cs](https://github.com/NetCoreTemplates/blazor-vue/blob/main/MyApp.ServiceModel/Bookings.cs):
304
303
305
304
```csharp
306
305
[Tag("bookings"), Description("Find Bookings")]
@@ -325,7 +324,7 @@ public class Booking : AuditBase
325
324
326
325
Where it generates clean API docs displayed in a human-friendly table layout containing properties of its **Request DTO** Type and inherited **base class** properties, starting with the APIs Request DTO followed by all its referenced dependent types - resulting in the details page containing a complete snapshot of all types used in the API:
@@ -403,7 +402,7 @@ The `*.html` file names aren't important, to create an API doc component it just
403
402
404
403
### Dynamic Components
405
404
406
-
[QueryTodos](https://vue-vite-api.jamstacks.net/ui/QueryTodos?tab=details) is a more advanced example that generates a dynamic UI shared by all TODO APIs:
405
+
[QueryTodos](https://blazor-vue.web-templates.io/ui/QueryTodos?tab=details) is a more advanced example that generates a dynamic UI shared by all TODO APIs:
407
406
408
407
```html
409
408
<script>
@@ -450,7 +449,7 @@ The `*.html` file names aren't important, to create an API doc component it just
450
449
451
450
To generate its reactive **Mini Navigation UI** users can use to cycle through **all TODO API docs** with a `v-href="{ op }"` custom directive:
Whilst [/ui/docs/AuthenticateDocs.html](https://github.com/ServiceStack/ServiceStack/blob/v6.6/ServiceStack/src/ServiceStack/modules/ui/docs/AuthenticateDocs.html) demonstrates a more advanced example in generating a responsive dynamic tab layout containing multiple relevant ServiceStack Auth YouTube videos:
@@ -524,7 +523,7 @@ You're also able to completely replace **any of API Explorers built-in component
524
523
[/modules/shared/Brand.html](https://github.com/LegacyTemplates/blazor-wasm/blob/main/MyApp/wwwroot/modules/shared/Brand.html) which overrides the top-right branding navigation for all API Explorer and Admin UIs:
0 commit comments