I actually use Doxygen to document my php REST application and I just discover Apiary & Swagger witch seem to be good tools to document API...I want to know if there is a way to generate documentation automatically using one of this tools (apiary or swagger ) based on the code comments?
Using swagger-php you can generate the documentation automatically from a collection of php scripts documented using annotations.
Swagger-PHP is decently documented here: http://zircote.com/swagger-php/
A working example can be found on github: https://github.com/zircote/swagger-php/tree/master/Examples/Petstore
Regarding the generation of the json file containing the documentation check my answer here: https://stackoverflow.com/a/31178997/2853903
Related
I've been trying to Add Attachments with a Google Calendar Addon using alternate runtimes (Not App scripts), but it seem it's either not documented anywhere or it's just impossible to do.
I'm wondering if anyone knows how this can be done returning proper JSON response from an alternate runtime, or is App Scripts the only option for adding attachments?
Thanks.
It should be possible to create Add ons with other runtimes as suggested by their official documentation.
There is also a quickstart that you can take a reference on how to create the add-on.
From the Calendar API events creation to add attachment it only supports Drive files. Sample codes in other languages on how to add the Drive files can be found here. There is also a thread utilizing Python and also wondering about the process of adding attachments.
Edit:
Would be a good idea to request a feature like that or update to the documentation for supported options:
https://developers.google.com/calendar/api/support
I'm trying to import Swagger JSON into AsciiDoc. To do that I'm trying to convert the Swagger JSON into markdown that can be read by AsciiDoc. I can't figure out how to do it. I've read that I will likely need to use swagger2markup. However, not being a Java programmer it's unclear how to use this. I got some clues from this answer but I can't get very far. It involves using J Unit and I don't know what to do with that and all that is required. Has anyone figured out how to do this?
I got some help from a coworker on how to convert the my Swagger JSON to AsciiDoc markdown. The more complex instructions here were not what I needed. The CLI instructions here were. The simpler conversion process using the CLI as opposed to integrating Swagger2Markdown into a Java app were ideal.
I am using google dataflow 1.9.1. Does Google Dataflow supports creating .zip (not .gz) file. I dont see an option in the api docs for .zip generation.
I see an enum, and the comments in TextIO.java suggest .withCompression should work. Alas, I don't see the .withCompression method. I have filed a JIRA to track.
I'm using sonarqube 5.6.5,everything works well . Now i need to parse the issues.PB file generated under .sonar/batch-report/ folder. i tried using jsonformat but it is not working.
They are "Protobuf" format, which is a format by google for serializing data. You can get started here or find for example a tutorial here on how to use it in Java.
What I don't understand is that your question has a tag "protobuf-net", which github page explains very well how to use it (in .NET).
I would like to use rails to output xml on a request from a client (Android device). I have gleaned from web searches that .builder.xml files are the way to go for this, but I cannot find a single tutorial or guide to get me started that is newer that 2006.. does anyone know of a good resource for xml and rails?
It's probably best to look at the official XML Builder homepage and follow/try the examples there: http://builder.rubyforge.org/
You can use XML Builder in both your controller or in your views, the code is the same. However, inside an .builder view you already have access to a builder instance via the "xml" variable. See: http://danengle.us/2009/05/generating-custom-xml-for-your-rails-app/
Take a look at this article about XML Builder.
I also highly recommend you to use Nokogiri to generate XML.