aboutsummaryrefslogtreecommitdiff
path: root/lib/VNLib.Plugins.Extensions.Loading/src/Routing/Mvc/HttpStaticRouteAttribute.cs
diff options
context:
space:
mode:
Diffstat (limited to 'lib/VNLib.Plugins.Extensions.Loading/src/Routing/Mvc/HttpStaticRouteAttribute.cs')
-rw-r--r--lib/VNLib.Plugins.Extensions.Loading/src/Routing/Mvc/HttpStaticRouteAttribute.cs53
1 files changed, 53 insertions, 0 deletions
diff --git a/lib/VNLib.Plugins.Extensions.Loading/src/Routing/Mvc/HttpStaticRouteAttribute.cs b/lib/VNLib.Plugins.Extensions.Loading/src/Routing/Mvc/HttpStaticRouteAttribute.cs
new file mode 100644
index 0000000..e37c50b
--- /dev/null
+++ b/lib/VNLib.Plugins.Extensions.Loading/src/Routing/Mvc/HttpStaticRouteAttribute.cs
@@ -0,0 +1,53 @@
+/*
+* Copyright (c) 2024 Vaughn Nugent
+*
+* Library: VNLib
+* Package: VNLib.Plugins.Extensions.Loading
+* File: HttpStaticRouteAttribute.cs
+*
+* HttpStaticRouteAttribute.cs is part of VNLib.Plugins.Extensions.Loading which is
+* part of the larger VNLib collection of libraries and utilities.
+*
+* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify
+* it under the terms of the GNU Affero General Public License as
+* published by the Free Software Foundation, either version 3 of the
+* License, or (at your option) any later version.
+*
+* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+* GNU Affero General Public License for more details.
+*
+* You should have received a copy of the GNU Affero General Public License
+* along with this program. If not, see https://www.gnu.org/licenses/.
+*/
+
+using System;
+
+using VNLib.Net.Http;
+
+namespace VNLib.Plugins.Extensions.Loading.Routing.Mvc
+{
+
+ /// <summary>
+ /// Attribute to define a static http endpoint for a controller. A static route is a
+ /// route that is configured at startup and does not do any type of dynamic pattern
+ /// matching.
+ /// </summary>
+ /// <param name="path">The static route path, may include configuration substitution variables</param>
+ /// <param name="method">The method (or methods) allowed to be filtered by this endpoint</param>
+ [AttributeUsage(AttributeTargets.Method, AllowMultiple = false, Inherited = true)]
+ public sealed class HttpStaticRouteAttribute(string path, HttpMethod method) : Attribute
+ {
+ /// <summary>
+ /// The path of the endpoint
+ /// </summary>
+ public string Path { get; } = path;
+
+ /// <summary>
+ /// The http method of the endpoint. You may set more than one method
+ /// for a given endpoint
+ /// </summary>
+ public HttpMethod Method { get; } = method;
+ }
+}