12 |
13 |
19 |
20 | @Html.DisplayForModel()
21 |
22 |
23 |
--------------------------------------------------------------------------------
/samples/WebApp/Areas/HelpPage/Views/Help/DisplayTemplates/ApiGroup.cshtml:
--------------------------------------------------------------------------------
1 | @using System.Web.Http
2 | @using System.Web.Http.Controllers
3 | @using System.Web.Http.Description
4 | @using WebApp.Areas.HelpPage
5 | @using WebApp.Areas.HelpPage.Models
6 | @model IGrouping
14 |
18 | 15 | @Html.ActionLink("Help Page Home", "Index") 16 |
17 |@Model.Key.ControllerName
15 | @if (!String.IsNullOrEmpty(controllerDocumentation)) 16 | { 17 |@controllerDocumentation
18 | } 19 || API | Description |
|---|---|
| @api.HttpMethod.Method @api.RelativePath | 28 |
29 | @if (api.Documentation != null)
30 | {
31 | @api.Documentation 32 | } 33 | else 34 | { 35 |No documentation available. 36 | } 37 | |
38 |
Possible enumeration values:
5 | 6 || Name | Value | Description |
|---|---|---|
| @value.Name | 15 |
16 | @value.Value 17 | |
18 |
19 | @value.Documentation 20 | |
21 |
@description.HttpMethod.Method @description.RelativePath
11 |
12 |
--------------------------------------------------------------------------------
/samples/WebApp/Areas/HelpPage/Views/Help/DisplayTemplates/ImageSample.cshtml:
--------------------------------------------------------------------------------
1 | @using WebApp.Areas.HelpPage
2 | @model ImageSample
3 |
4 | @description.Documentation
13 | 14 |Request Information
15 | 16 |URI Parameters
17 | @Html.DisplayFor(m => m.UriParameters, "Parameters") 18 | 19 |Body Parameters
20 | 21 |@Model.RequestDocumentation
22 | 23 | @if (Model.RequestModelDescription != null) 24 | { 25 | @Html.DisplayFor(m => m.RequestModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.RequestModelDescription }) 26 | if (Model.RequestBodyParameters != null) 27 | { 28 | @Html.DisplayFor(m => m.RequestBodyParameters, "Parameters") 29 | } 30 | } 31 | else 32 | { 33 |None.
34 | } 35 | 36 | @if (Model.SampleRequests.Count > 0) 37 | { 38 |Request Formats
39 | @Html.DisplayFor(m => m.SampleRequests, "Samples") 40 | } 41 | 42 |Response Information
43 | 44 |Resource Description
45 | 46 |@description.ResponseDescription.Documentation
47 | 48 | @if (Model.ResourceDescription != null) 49 | { 50 | @Html.DisplayFor(m => m.ResourceDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.ResourceDescription }) 51 | if (Model.ResourceProperties != null) 52 | { 53 | @Html.DisplayFor(m => m.ResourceProperties, "Parameters") 54 | } 55 | } 56 | else 57 | { 58 |None.
59 | } 60 | 61 | @if (Model.SampleResponses.Count > 0) 62 | { 63 |Response Formats
64 | @Html.DisplayFor(m => m.SampleResponses, "Samples") 65 | } 66 | 67 |Sample not available.
13 | } -------------------------------------------------------------------------------- /samples/WebApp/Areas/HelpPage/Views/Help/DisplayTemplates/KeyValuePairModelDescription.cshtml: -------------------------------------------------------------------------------- 1 | @using WebApp.Areas.HelpPage.ModelDescriptions 2 | @model KeyValuePairModelDescription 3 | Pair of @Html.DisplayFor(m => Model.KeyModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.KeyModelDescription }) [key] 4 | and @Html.DisplayFor(m => Model.ValueModelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = Model.ValueModelDescription }) [value] -------------------------------------------------------------------------------- /samples/WebApp/Areas/HelpPage/Views/Help/DisplayTemplates/ModelDescriptionLink.cshtml: -------------------------------------------------------------------------------- 1 | @using WebApp.Areas.HelpPage.ModelDescriptions 2 | @model Type 3 | @{ 4 | ModelDescription modelDescription = ViewBag.modelDescription; 5 | if (modelDescription is ComplexTypeModelDescription || modelDescription is EnumTypeModelDescription) 6 | { 7 | if (Model == typeof(Object)) 8 | { 9 | @:Object 10 | } 11 | else 12 | { 13 | @Html.ActionLink(modelDescription.Name, "ResourceModel", "Help", new { modelName = modelDescription.Name }, null) 14 | } 15 | } 16 | else if (modelDescription is CollectionModelDescription) 17 | { 18 | var collectionDescription = modelDescription as CollectionModelDescription; 19 | var elementDescription = collectionDescription.ElementDescription; 20 | @:Collection of @Html.DisplayFor(m => elementDescription.ModelType, "ModelDescriptionLink", new { modelDescription = elementDescription }) 21 | } 22 | else 23 | { 24 | @Html.DisplayFor(m => modelDescription) 25 | } 26 | } -------------------------------------------------------------------------------- /samples/WebApp/Areas/HelpPage/Views/Help/DisplayTemplates/Parameters.cshtml: -------------------------------------------------------------------------------- 1 | @using System.Collections.Generic 2 | @using System.Collections.ObjectModel 3 | @using System.Web.Http.Description 4 | @using System.Threading 5 | @using WebApp.Areas.HelpPage.ModelDescriptions 6 | @model IList| Name | Description | Type | Additional information |
|---|---|---|---|
| @parameter.Name | 20 |
21 | @parameter.Documentation 22 | |
23 | 24 | @Html.DisplayFor(m => modelDescription.ModelType, "ModelDescriptionLink", new { modelDescription = modelDescription }) 25 | | 26 |
27 | @if (parameter.Annotations.Count > 0)
28 | {
29 | foreach (var annotation in parameter.Annotations)
30 | {
31 | @annotation.Documentation 32 | } 33 | } 34 | else 35 | { 36 |None. 37 | } 38 | |
39 |
None.
47 | } 48 | 49 | -------------------------------------------------------------------------------- /samples/WebApp/Areas/HelpPage/Views/Help/DisplayTemplates/Samples.cshtml: -------------------------------------------------------------------------------- 1 | @using System.Net.Http.Headers 2 | @model Dictionary
12 | @foreach (var mediaType in mediaTypes)
13 | {
14 |
--------------------------------------------------------------------------------
/samples/WebApp/Areas/HelpPage/Views/Help/DisplayTemplates/SimpleTypeModelDescription.cshtml:
--------------------------------------------------------------------------------
1 | @using WebApp.Areas.HelpPage.ModelDescriptions
2 | @model SimpleTypeModelDescription
3 | @Model.Documentation
--------------------------------------------------------------------------------
/samples/WebApp/Areas/HelpPage/Views/Help/DisplayTemplates/TextSample.cshtml:
--------------------------------------------------------------------------------
1 | @using WebApp.Areas.HelpPage
2 | @model TextSample
3 |
4 | @mediaType
15 |
16 | Sample:
17 | @{
18 | var sample = samples[mediaType];
19 | if (sample == null)
20 | {
21 |
29 | }
30 | Sample not available.
22 | } 23 | else 24 | { 25 | @Html.DisplayFor(s => sample); 26 | } 27 | } 28 |5 | @Model.Text 6 |-------------------------------------------------------------------------------- /samples/WebApp/Areas/HelpPage/Views/Help/Index.cshtml: -------------------------------------------------------------------------------- 1 | @using System.Web.Http 2 | @using System.Web.Http.Controllers 3 | @using System.Web.Http.Description 4 | @using System.Collections.ObjectModel 5 | @using WebApp.Areas.HelpPage.Models 6 | @model Collection
18 |
22 |
19 |
21 | @ViewBag.Title
20 |
24 |
25 |
32 |
33 | @foreach (var group in apiGroups)
34 | {
35 | @Html.DisplayFor(m => group, "ApiGroup")
36 | }
37 |
38 |
39 |
--------------------------------------------------------------------------------
/samples/WebApp/Areas/HelpPage/Views/Help/ResourceModel.cshtml:
--------------------------------------------------------------------------------
1 | @using System.Web.Http
2 | @using WebApp.Areas.HelpPage.ModelDescriptions
3 | @model ModelDescription
4 |
5 |
6 |
26 |
31 | Introduction
27 |28 | Provide a general description of your APIs here. 29 |
30 |
7 |
8 |
14 |
17 | @Html.DisplayFor(m => Model)
18 |
19 |
20 |
--------------------------------------------------------------------------------
/samples/WebApp/Areas/HelpPage/Views/Shared/_Layout.cshtml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
9 |
13 | 10 | @Html.ActionLink("Help Page Home", "Index") 11 |
12 |@Model.Name
15 |@Model.Documentation
16 |Error.
10 |An error occurred while processing your request.
11 | 12 | 13 | 14 | -------------------------------------------------------------------------------- /samples/WebApp/Views/Shared/_Layout.cshtml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
31 | @RenderBody()
32 |
33 |
38 |
39 | @Scripts.Render("~/bundles/jquery")
40 | @Scripts.Render("~/bundles/bootstrap")
41 | @RenderSection("scripts", required: false)
42 |
43 |
44 |
--------------------------------------------------------------------------------
/samples/WebApp/Views/Web.config:
--------------------------------------------------------------------------------
1 |
2 |
3 | 33 |
@WebApiApplication.UnleashInfo
34 | 37 |@ViewData["Title"]
7 |@Model.Message
8 | 9 |Use this area to provide additional information.
10 | -------------------------------------------------------------------------------- /samples/WebAppCore/Pages/About.cshtml.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Threading.Tasks; 5 | using Microsoft.AspNetCore.Mvc.RazorPages; 6 | 7 | namespace WebAppCore.Pages 8 | { 9 | public class AboutModel : PageModel 10 | { 11 | public string Message { get; set; } 12 | 13 | public void OnGet() 14 | { 15 | Message = "Your application description page."; 16 | } 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /samples/WebAppCore/Pages/Contact.cshtml: -------------------------------------------------------------------------------- 1 | @page 2 | @model ContactModel 3 | @{ 4 | ViewData["Title"] = "Contact"; 5 | } 6 |@ViewData["Title"]
7 |@Model.Message
8 | 9 | 10 | One Microsoft Way11 | Redmond, WA 98052-6399
12 | P: 13 | 425.555.0100 14 | 15 | 16 | 17 | Support: Support@example.com
18 | Marketing: Marketing@example.com 19 | 20 | -------------------------------------------------------------------------------- /samples/WebAppCore/Pages/Contact.cshtml.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Threading.Tasks; 5 | using Microsoft.AspNetCore.Mvc.RazorPages; 6 | 7 | namespace WebAppCore.Pages 8 | { 9 | public class ContactModel : PageModel 10 | { 11 | public string Message { get; set; } 12 | 13 | public void OnGet() 14 | { 15 | Message = "Your contact page."; 16 | } 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /samples/WebAppCore/Pages/Error.cshtml: -------------------------------------------------------------------------------- 1 | @page 2 | @model ErrorModel 3 | @{ 4 | ViewData["Title"] = "Error"; 5 | } 6 | 7 |
Error.
8 |An error occurred while processing your request.
9 | 10 | @if (Model.ShowRequestId) 11 | { 12 |
13 | Request ID: @Model.RequestId
14 |
Development Mode
18 |19 | Swapping to Development environment will display more detailed information about the error that occurred. 20 |
21 |22 | Development environment should not be enabled in deployed applications, as it can result in sensitive information from exceptions being displayed to end users. For local debugging, development environment can be enabled by setting the ASPNETCORE_ENVIRONMENT environment variable to Development, and restarting the application. 23 |
24 | -------------------------------------------------------------------------------- /samples/WebAppCore/Pages/Error.cshtml.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Diagnostics; 4 | using System.Linq; 5 | using System.Threading.Tasks; 6 | using Microsoft.AspNetCore.Mvc.RazorPages; 7 | 8 | namespace WebAppCore.Pages 9 | { 10 | public class ErrorModel : PageModel 11 | { 12 | public string RequestId { get; set; } 13 | 14 | public bool ShowRequestId => !string.IsNullOrEmpty(RequestId); 15 | 16 | public void OnGet() 17 | { 18 | RequestId = Activity.Current?.Id ?? HttpContext.TraceIdentifier; 19 | } 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /samples/WebAppCore/Pages/Index.cshtml.cs: -------------------------------------------------------------------------------- 1 | using System; 2 | using System.Collections.Generic; 3 | using System.Linq; 4 | using System.Threading.Tasks; 5 | using Microsoft.AspNetCore.Mvc; 6 | using Microsoft.AspNetCore.Mvc.RazorPages; 7 | 8 | namespace WebAppCore.Pages 9 | { 10 | public class IndexModel : PageModel 11 | { 12 | public void OnGet() 13 | { 14 | 15 | } 16 | } 17 | } 18 | -------------------------------------------------------------------------------- /samples/WebAppCore/Pages/_Layout.cshtml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
41 | @RenderBody()
42 |
43 | 46 |
47 |
48 | 43 | 46 |