Skip to content

Commit

Permalink
Update the template version to 1.10
Browse files Browse the repository at this point in the history
  • Loading branch information
Sergey Tregub committed May 23, 2020
1 parent 3601452 commit 2e13f12
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 8 deletions.
6 changes: 3 additions & 3 deletions ProjectTemplates/How to create new template.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ After making any changes do:
1. Select Release configuration for a solution
1. Select ReferenceProject in "Solution Explorer" and click "Project/Export Template..." menu item from the VS main menu
1. In the appeared dialog box select "Project template" option and "ReferenceProject" in the combobox below and click Next
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
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
1. Clear checkbox "Automatically import the template into Visual Studio" if you don't want immediately import it and click Finish button
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
1. Open ReferenceProject.csproj file in any text editor and find "DocumentationFile" tag
Expand All @@ -16,5 +16,5 @@ After making any changes do:
1. Go to VS, expand a ReferenceProjectVSIX project and double click on a "source.extension.vsixmanifest" file
1. Increase minor version number on the tab "Metadata" in the top right corner
1. Rebuild the ReferenceProjectVSIX project and get "ASP.Net WebAPI Application Project Template.vsix"

That's all. "ASP.Net WebAPI Application Project Template.vsix" can be uploaded to VS Marketplace or installed in VS.
1. "ASP.Net WebAPI Application Project Template.vsix" can be uploaded to VS Marketplace or installed in VS.
1. Create a new release on GitHub
2 changes: 1 addition & 1 deletion ProjectTemplates/ReferenceProject/MyTemplate.vstemplate
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<VSTemplate Version="3.0.0" xmlns="http://schemas.microsoft.com/developer/vstemplate/2005" Type="Project">
<TemplateData>
<Name>ASP.Net WebAPI Application with OWIN</Name>
<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>
<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>
<ProjectType>CSharp</ProjectType>
<ProjectSubType>
</ProjectSubType>
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
<?xml version="1.0" encoding="utf-8"?>
<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">
<Metadata>
<Identity Id="ASP.Net WebAPI Application Project Template-1" Version="1.9" Language="en-US" Publisher="Sergey Tregub" />
<Identity Id="ASP.Net WebAPI Application Project Template-1" Version="1.10" Language="en-US" Publisher="Sergey Tregub" />
<DisplayName>ASP.Net WebAPI Application Project Template</DisplayName>
<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>
<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>
<MoreInfo>https://github.com/drwatson1/AspNet-WebApi</MoreInfo>
<GettingStartedGuide>https://github.com/drwatson1/AspNet-WebApi/wiki</GettingStartedGuide>
<Icon>Assets\logo.png</Icon>
Expand Down
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ Repository contains ready to use preconfigured project to create fully functiona

> 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).
It contains:
The template uses the 4.7.1 version of .Net Framework. Make sure that you have it installed before using the template.

**Contains**

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

Read [Wiki](https://github.com/drwatson1/AspNet-WebApi/wiki) for more information.
**Getting Started**

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.
1. Restart Visual Studio
1. Click on "File/New Project..." menu item
1. Type "webapi" on the right pane
1. Select "APS.Net WebAPI Application With OWIN" and click OK button.
1. Run the service
1. Open a browser and navigate to http://localhost:5000/swagger/ui/index to see API documentation
1. Play around with the API

Visit project [Wiki pages](https://github.com/drwatson1/AspNet-WebApi/wiki) to learn more about the template.

Any suggestions and bug reports are very appeciated.

0 comments on commit 2e13f12

Please sign in to comment.