Skip to content

Add a Info endpoint that gives out the component version number in either text or shields.io format

License

Notifications You must be signed in to change notification settings

WrapThat/Version

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

WrapThat.Version

##: Install

Install from nuget

Usage

Add this package to your main ASP.Net project, and it will add an Info endpoint with five methods, giving you the version of the main assembly in semver format.

Get version as a string

Route:  /api/info/version

returns
1.2.3

Get product version as a string

Route:  /api/info/productversion

returns
1.2.3-rc.1

Get version as a shields.io structure

Route:  /api/info/shields/version

returns shields io structure for use in a [shields endpoint](https://shields.io/endpoint) call.

You call this using shields like:

https://img.shields.io/endpoint?url=https://yourwebapi/api/info

And you get a lightgrey shields badge back, with label Version and your version number.

Get ProductVersion as a shields.io structure

Route:  /api/info/shields/productversion

returns shields io structure for use in a [shields endpoint](https://shields.io/endpoint) call.

You call this using shields like:

https://img.shields.io/endpoint?url=https://yourwebapi/api/info/productversion

And you get a lightgrey shields badge back, with label Version and your version number.

Get version as a string authenticated

This is the same as the first method, except that it require authentication, if your API/app is set up for that. The intention is that you can use this to check if the authentication is actually working.

If it is, you will be returned the version string, if not, you will get a 403 response.

Route:  /api/info/status

returns
1.2.3

About

Add a Info endpoint that gives out the component version number in either text or shields.io format

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages