Skip to content

Commit 2e13f12

Browse files
author
Sergey Tregub
committed
Update the template version to 1.10
1 parent 3601452 commit 2e13f12

5 files changed

Lines changed: 22 additions & 8 deletions

File tree

ProjectTemplates/How to create new template.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ After making any changes do:
55
1. Select Release configuration for a solution
66
1. Select ReferenceProject in "Solution Explorer" and click "Project/Export Template..." menu item from the VS main menu
77
1. In the appeared dialog box select "Project template" option and "ReferenceProject" in the combobox below and click Next
8-
1. Set the value "ASP.Net WebAPI Application with OWIN" as a template name and "Project template to create production-ready RESTful service based on ASP.Net WebAPI and OWIN. It contains preconfigured DI-container, logging, CORS, JWT-bearer authentication, boilerplate code and other features" as a description
8+
1. Set the value "ASP.Net WebAPI Application with OWIN" as a template name and "Project template to create production-ready RESTful service based on ASP.Net WebAPI and OWIN. It contains Swagger documentation, preconfigured DI-container, logging, CORS, JWT-bearer authentication, boilerplate code and other features" as a description
99
1. Clear checkbox "Automatically import the template into Visual Studio" if you don't want immediately import it and click Finish button
1010
1. Extract all files from the created zip-archive to any folder as you want. Typically, the file can be found in "C:\Users\<YOU>\Documents\Visual Studio 2017\My Exported Templates" folder
1111
1. Open ReferenceProject.csproj file in any text editor and find "DocumentationFile" tag
@@ -16,5 +16,5 @@ After making any changes do:
1616
1. Go to VS, expand a ReferenceProjectVSIX project and double click on a "source.extension.vsixmanifest" file
1717
1. Increase minor version number on the tab "Metadata" in the top right corner
1818
1. Rebuild the ReferenceProjectVSIX project and get "ASP.Net WebAPI Application Project Template.vsix"
19-
20-
That's all. "ASP.Net WebAPI Application Project Template.vsix" can be uploaded to VS Marketplace or installed in VS.
19+
1. "ASP.Net WebAPI Application Project Template.vsix" can be uploaded to VS Marketplace or installed in VS.
20+
1. Create a new release on GitHub

ProjectTemplates/ReferenceProject/MyTemplate.vstemplate

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<VSTemplate Version="3.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Project">
22
<TemplateData>
33
<Name>ASP.Net WebAPI Application with OWIN</Name>
4-
<Description>Project template to create production-ready RESTful service based on ASP.Net WebAPI and OWIN. It contains preconfigured DI-container, logging, CORS, JWT-bearer authentication, boilerplate code and other features</Description>
4+
<Description>Project template to create production-ready RESTful service based on ASP.Net WebAPI and OWIN. It contains Swagger documentation, preconfigured DI-container, logging, CORS, JWT-bearer authentication, boilerplate code and other features</Description>
55
<ProjectType>CSharp</ProjectType>
66
<ProjectSubType>
77
</ProjectSubType>

ProjectTemplates/ReferenceProjectVSIX/source.extension.vsixmanifest

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<PackageManifest Version="2.0.0" xmlns="http://schemas.microsoft.com/developer/vsx-schema/2011" xmlns:d="http://schemas.microsoft.com/developer/vsx-schema-design/2011">
33
<Metadata>
4-
<Identity Id="ASP.Net WebAPI Application Project Template-1" Version="1.9" Language="en-US" Publisher="Sergey Tregub" />
4+
<Identity Id="ASP.Net WebAPI Application Project Template-1" Version="1.10" Language="en-US" Publisher="Sergey Tregub" />
55
<DisplayName>ASP.Net WebAPI Application Project Template</DisplayName>
6-
<Description xml:space="preserve">Project template to create production-ready RESTful service based on ASP.Net WebAPI and OWIN. It contains preconfigured DI-container, logging, CORS, JWT-bearer authentication, boilerplate code and other features</Description>
6+
<Description xml:space="preserve">Project template to create production-ready RESTful service based on ASP.Net WebAPI and OWIN. It contains Swagger-documentation, preconfigured DI-container, logging, CORS, JWT-bearer authentication, boilerplate code and other features</Description>
77
<MoreInfo>https://github.com/drwatson1/AspNet-WebApi</MoreInfo>
88
<GettingStartedGuide>https://github.com/drwatson1/AspNet-WebApi/wiki</GettingStartedGuide>
99
<Icon>Assets\logo.png</Icon>

README.md

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ Repository contains ready to use preconfigured project to create fully functiona
44

55
> Note! If you are looking for a .Net Core project template, please, check out the project [ASP.Net Core RESTful Service Project Template](https://github.com/drwatson1/AspNet-Core-REST-Service).
66
7-
It contains:
7+
The template uses the 4.7.1 version of .Net Framework. Make sure that you have it installed before using the template.
8+
9+
**Contains**
810

911
- CORS enabled
1012
- preconfigured HTTP OPTIONS handler
@@ -21,5 +23,17 @@ It contains:
2123
- Support .env files to easy switching between different environments (DotNetEnv)
2224
- ... and some other boilerplate code
2325

24-
Read [Wiki](https://github.com/drwatson1/AspNet-WebApi/wiki) for more information.
26+
**Getting Started**
27+
28+
1. Install the extension from the [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=sergey-tregub.asp-net-web-api-owin-template) or download and install the latest version from the [GitHub](https://github.com/drwatson1/AspNet-WebApi/releases). Also, you can install it from Visual Studio. To do so click on "Tools/Extensions and Updates..." menu item, then select "Online/Visual Studio Marketplace/Templates" on the left pane, search for "ASP.Net WebAPI Application Project Template," select it and click "Download" button.
29+
1. Restart Visual Studio
30+
1. Click on "File/New Project..." menu item
31+
1. Type "webapi" on the right pane
32+
1. Select "APS.Net WebAPI Application With OWIN" and click OK button.
33+
1. Run the service
34+
1. Open a browser and navigate to http://localhost:5000/swagger/ui/index to see API documentation
35+
1. Play around with the API
36+
37+
Visit project [Wiki pages](https://github.com/drwatson1/AspNet-WebApi/wiki) to learn more about the template.
38+
2539
Any suggestions and bug reports are very appeciated.

0 commit comments

Comments
 (0)