aboutsummaryrefslogtreecommitdiff
path: root/MediaBrowser.Common/README.txt
diff options
context:
space:
mode:
Diffstat (limited to 'MediaBrowser.Common/README.txt')
-rw-r--r--MediaBrowser.Common/README.txt41
1 files changed, 41 insertions, 0 deletions
diff --git a/MediaBrowser.Common/README.txt b/MediaBrowser.Common/README.txt
new file mode 100644
index 000000000..e8ce34205
--- /dev/null
+++ b/MediaBrowser.Common/README.txt
@@ -0,0 +1,41 @@
+ServiceStack services should be available under '/api' path. If it's a brand new MVC project
+install NuGet Package: ServiceStack.Host.Mvc. The package prepares ServiceStack default services. Make sure
+that you added ignore for MVC routes:
+
+ routes.IgnoreRoute("api/{*pathInfo}");
+
+If it's MVC4 project, then don't forget to disable WebAPI:
+
+ //WebApiConfig.Register(GlobalConfiguration.Configuration);
+
+Enable Swagger plugin in AppHost.cs with:
+
+ public override void Configure(Container container)
+ {
+ ...
+
+ Plugins.Add(new SwaggerFeature());
+ // uncomment CORS feature if it's has to be available from external sites
+ //Plugins.Add(new CorsFeature());
+ ...
+
+ }
+
+Compile it. Now you can access swagger UI with:
+
+http://localost:port/swagger-ui/index.html
+
+or
+
+http://yoursite/swagger-ui/index.html
+
+
+For more info about ServiceStack please visit: http://www.servicestack.net
+
+Feel free to ask questions about ServiceStack on:
+http://stackoverflow.com/
+
+or on the mailing Group at:
+http://groups.google.com/group/servicestack
+
+Enjoy! \ No newline at end of file