Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
I'm writing an XML-RPC service that will be consumed by third parties and was wondering what the best way of documenting it would be.
As far as I can see, XML-RPC doesn't have any equivalent to SOAP's WSDL to provide a description of the service, so presumably it's something I will have to document by hand?
So far I've come accross examples such as that found here and here where documentation basically consists of an example call with place holders for data.
Is there any better method than this that I'm missing?
Thanks.
Check out XML-RPC Introspection. It is about the closest thing to a standard that you are going to find. XML-RPC does lend itself to simple documents of input/output descriptions. If you want something that can be processed programatically, then implement or enable introspection.
Related
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Are there any plugins out there (similar to Swagger) which provide the ability to document HATEOAS APIs?
The Swagger interface is quite good but it doesn't have level 3 REST support.
I use spring-restdocs in combination with the HAL-browser.
You don't necessarily need HAL for restdocs though, although it is recommended.
Restdocs will generate code samples and link & field descriptors in the asciidoc format. You can then link to these asciidocs from inside the HAL-browser.
To see the result in action (although this is hardcoded), check this out: foxycart. Click on the little doc links next to the rels.
After further investigation I discovered HAL-browser (https://github.com/mikekelly/hal-browser) which is quite good. Although, your API must return content-type of HAL for it.
You don't need to configure anything on the server for this tool. Just open it in a browser and point to your API.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Is there a documentation tool for a WCF endpoint out there?
We are trying to setup governance of our WCF Services and it would be really nice to auto document the list of service operations on a given endpoint.
For example: http://MyService:8080/Client.svc has the SaveClient, UpdateClient, GetClientById etc. If I was auto generating documents then when a DeleteClient service gets added it is really easy to flag that for my SOA Governance Board to look at.
I know I could write my own using the code generation tools provided by Microsoft, but I was hoping that someone else already got this idea and coded it up for me.
(Basically I am looking for a WSDL to MS Word tool.)
I just need to google a bit differently.
Generating HTML documentation from WSDL
That question pointed me to WSDL Viewer, which seems to do what I need.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 4 years ago.
Improve this question
Looking for examples of Push APIs, other than the websocket or the comet or the pubsub.
Need examples specifically for communication between two systems (versus Client/Browser - Server). In other words it doesn't have to be over HTTP.
PubSubHubbub A simple, open, server-to-server web-hook-based pubsub (publish/subscribe) protocol as an extension to Atom and RSS.
They also have a wiki page for comparing different protocols.
There are several somewhat evolved APIs for this. Here is one for jQuery. Here is a blog post describing how to implement this in ASP.NET. It's a difficult framework to idea due to that pesky constant connectivity thing.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 8 years ago.
Improve this question
I'm building a web application and i want to send Snail Mail automatically by server side, Is there any good APIs for that? ( i don't mind about the cost )
P.S. I'll hate you if you say it's not programming related, and i bet many coders here would love to know.
Thanks!
Here's a list of mailing services I found with APIs, or something close to it
https://click2mail.com/ (REST and SOAP)
http://www.postalmethods.com/ (SOAP)
http://l-mail.com/ has an 'integration' account. It is not clear how automatable sending a letter is.
http://www.cfhdocmail.com/ (SOAP)
http://www.ezgram.com/ has an HTML based interface you might be able to reverse engineer
https://www.trypaper.com/ (REST)
https://www.lob.com/ (REST)
I just found Postal Methods API. I haven't really seen any others.
Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.
We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.
Closed 5 years ago.
Improve this question
Our company has a very large public Java API which is currently being released standalone and online using (of course) JavaDoc. It is surrounded by product documentation which links into the API.
We are moving our static documentation to DokuWiki - which works pretty good - and want to keep the links.
Now it would be good to have a method (or doclet) that exports the JavaDoc directly into DokuWiki - or a very near alternative.
Question: Is there something like this or do you know a method to do just that?
Here's a Doclet which writes to JSON.
https://bitbucket.org/ananelson/json-doclet/src/tip/src/it/dexy/jsondoclet/Doclet.java
It might help get you started writing a custom Doclet.
You need to write doclet yourself, its not hard - its just html generation from very nice meta-model.
this might help
P.S. doclet api is in lib/tools.jar of your sdk.