Geek Answers Handbook

ServiceStack Web Services Documentation

What are the options for documenting ServiceStack database web services, and I'm not talking about a single line.

I would like to be able to document in detail (which may be long), return types, possible HTTP responses, add detailed examples, etc.

Is there any support for this in ServiceStack (I could not find it)? If no one has solved the problem in any other way.

+5
source share
2 answers

You can provide metadata descriptions for each of your web services by assigning your DTO requests with the attributes [Api] and [ApiMember]. This information will be displayed on dynamic metadata pages.

Another option is to simply create your own dynamic html page that ServiceStack allows you to do by simply returning a line (containing your html markup). If you go this route, you can access the Service Types metadata with the global EndpointHost.ServiceOperations property.

Also, if dynamically creating html with C # is not your preference, you can also generate html using the Razor built-in markup format , which makes html generation pretty nice :)

+4
source

I understand this question a couple of years, but now there is Swagger support for the ServiceStack API @ https://github.com/ServiceStack/ServiceStack/wiki/Swagger-API

+1
source

More articles:


All Articles