Git Product home page Git Product logo

apiurlsgenerator's Introduction

API URL's Generator

GitHub Actions status

This library will help you to convert your stringly typed API URL's to strongly typed ones.

To use it, first add its package to your ASP.NET Core Web-API application:

Nuget

dotnet add package ApiUrlsGenerator

Then add its services to your services registration pipeline:

#if DEBUG
builder.Services.AddApiUrlsGenerator(options =>
                                     {
                                         options.OutputFolder = @"..\Shared";
                                         options.OutputFileName = "ApiUrls.cs";
                                         options.DefaultNamespace = "StronglyTypedApiUrls";
                                     });
#endif

With the above settings, a new OutputFileName file will be created in the OutputFolder and this new class has the specified DefaultNamespace namespace. Note: if the OutputFolder doesn't exist, nothing will happen.

After adding the above settings, run the application to create the ApiUrls.cs file. Note: After each changes to the route definitions of your action methods, you should run the application to update ApiUrls.cs file automatically. Now instead of writing a URL like:

var secretUrl = "api/WeatherForecast/_secretUrl";

You can replace it with a compiler/refactoring friendly version:

var secretUrl = ApiUrls.WeatherForecast.HttpGet.SecretUrl;

Here you can find a sample controller and another one in a new area, with the generated ApiUrls.cs file.

apiurlsgenerator's People

Contributors

vahidn avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.