Started documenting the API we now have swagger under ~/apidocs

#222 #205

PlexRequests.UI/Modules/ApiMetadataModule.cs

@@ -0,0 +1,82 @@
+#region Copyright
+// /************************************************************************
+//    Copyright (c) 2016 Jamie Rees
+//    File: ApiMetadataModule.cs
+//    Created By: Jamie Rees
+//   
+//    Permission is hereby granted, free of charge, to any person obtaining
+//    a copy of this software and associated documentation files (the
+//    "Software"), to deal in the Software without restriction, including
+//    without limitation the rights to use, copy, modify, merge, publish,
+//    distribute, sublicense, and/or sell copies of the Software, and to
+//    permit persons to whom the Software is furnished to do so, subject to
+//    the following conditions:
+//   
+//    The above copyright notice and this permission notice shall be
+//    included in all copies or substantial portions of the Software.
+//   
+//    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+//    EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+//    MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+//    NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+//    LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+//    OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+//    WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+//  ************************************************************************/
+#endregion
+using System.Collections.Generic;
+
+using Nancy.Metadata.Modules;
+using Nancy.Swagger;
+
+using PlexRequests.Store;
+
+namespace PlexRequests.UI.Modules
+{
+    public class ApiMetadataModule: MetadataModule<SwaggerRouteData>
+    {
+        public ApiMetadataModule()
+        {
+            Describe["GetRequests"] = description => description.AsSwagger(with =>
+            {
+                with.ResourcePath("/requests");
+                with.Summary("The list of requests");
+
+                with.Notes("This returns a list of users from our awesome app");
+                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
+                with.Model<ApiModel<List<RequestedModel>>>();
+            });
+
+            Describe["PostRequests"] = description => description.AsSwagger(with =>
+            {
+                with.ResourcePath("/requests");
+                with.Summary("Create a new request");
+                with.Model<ApiModel<bool>>();
+                with.BodyParam<RequestedModel>("The request", true);
+                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
+                with.Notes("Creates a new request");
+            });
+
+            Describe["PutRequests"] = description => description.AsSwagger(with =>
+            {
+                with.ResourcePath("/requests");
+                with.Summary("Updates an existing request");
+                with.Model<ApiModel<bool>>();
+                with.BodyParam<RequestedModel>("The request", true);
+                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
+                with.Notes("Updates an existing request e.g. Add a issue to the request");
+            });
+
+            Describe["DeleteRequests"] = description => description.AsSwagger(with =>
+            {
+                with.ResourcePath("/requests");
+                with.Summary("Deletes an existing request");
+                with.Model<ApiModel<bool>>();
+                with.BodyParam<RequestedModel>("The request", true);
+                with.QueryParam<string>("apikey", "The Api Key found in the settings", true);
+                with.Notes("Deletes an existing request. If the request doesn't exist we will return an error.");
+            });
+
+        }
+    }
+}