I have a REST webservice using Codeigniter and using this lib : https://github.com/chriskacerguis/codeigniter-restserver
I want to generate documentation for this web service. I look to use Swagger UI to generate this documentation. But, I didn't find any documentation how to use Swagger with Codeigniter.
The only project using this two technologies is this one, but don't have a good documentation : https://github.com/panxp/codeigniter-swagger
Can someone paste an example using this two technologies or give me a link to a good documentation ?
Of course, if there is another good lib to generate documentation, I'll take it if it's usable with Codeigniter.
In past projects I have used http://apidocjs.com/ which I find pretty easy to use and straightforward to generate from in multiple environments. It took me like 15-20 minutes to get going and looking how I wanted with it having npm already installed. This one doesn't really care about directory or code structure, just your supplied info in the doc blocks.
You Can use https://github.com/manish29ify/codeigniter3-restapi-with-swagger Still it is under development but you can use Swagger with PHP rest server very easily
Related
What is the simplest tool to create a useful code documentation for web appliaction based on Yii 1.1 framework (that used PHP language).
I need a manual way not auto generating tool, and I need something simple to use like Word and not something needs cmd or any console to create the documentation.
I hope my question is clear this time :)
I am looking to implement Angular2 inside my current Laravel project. I've read about many setups including AngularClass's version with Webpack, but I feel like it's all over-complicated.
What I wish to make:
A simple single page app inside my Laravel app.
It needs to have something like Grunt/Gulp or even Webpack to compile upon changes.
Does not need NodeJs to run in production, no lite-server, just like AngularJS it can be injected and that's it.
I need to understand the implementation files to achieve this, so no starterpack or angular-cli, unless if you can supply good arguments.
Looking for a "how to"-like example on creating the above.
Thanks in advance.
EDIT: More information
As ANKH pointed out, i needed a more detailed and coursed question. So here we go:
- Looking for a example implementation of a Angular2 based SPA inside an existing PHP application (Laravel).
- I've tried many different tutorials, going from the heroes tour, to Sitepoint and AngularCLI based tutorials, but they all assume a SPA on it's own. Ergo, they are compiled and served through NodeJS, which I don't need.
Turns out that I've actually been looking at this entirely wrong. I've gone with using Angular-cli and found that I could generate the output files and include these inside my Laravel project. No need to integrate them further.
I'm looking for a script (there has to be one) that help me to let me user translate my getText based PHP project.
Right now, I don't have time to create a solution on my one, so I were looking for some proper open-source solution using Google Search, but I could not find anything.
There are a lot of commercial solutions for this, but I would like to use a simple PHP alternative on my own server. It does not have to have a lot of features; I just want to select the languages I need and let the people translate and check translations.
I don't know of any solutions in PHP, but there are several open source projects for web-based translation tools. For example:
Weblate is based on Python/Django and supports Git integration. I think it is used by phpMyAdmin, so it should be suitable for PHP projects.
Zanata is written in Java and used by JBoss.
I also found SimplePO on Google Code which is written in PHP, but it does not seem to support plural forms. There is also a more recently updated fork on GitHub.
Is there any way to embed a wiki inside a PHP application? My specific use is inside a CakePHP framework app. I also need to be able to add custom tags. Anyone have an idea to which direction I should be taking?
I am not aware of a wiki plugin that is easy to integrate in a CakePHP project.
If I were you I would try to install this: http://bakery.cakephp.org/articles/adael/2011/08/27/adawiki2_an_easy_to_use_wiki_made_in_cakephp and integrate it within the original application.
EDIT
Pear wiki could be a solution.
You can see the following thread about the resolution of this issue: how to use Pear Text_wiki.
I need a documentation system for a PHP project and I wanted it to be able to integrate external documentation (use cases, project scope etc.) with the documentation generated from code comments. It seems that phpDocumentor has exactly the right feature set, but external documentation must be written in DocBook which is too complex for our team.
If it were in python, sphinx would be just about perfect for this job (ReST is definitely simpler than docbook). Is there any way I can integrate external ReST documentation with the docs extracted from phpdoc? Should I just separate the external documentation (eg. use ReST for external and phpdoc for internal)? Or do you have a better suggestion for managing the external documentation?
You can convert ReST to DocBook using pandoc.
convert wordpress posts in DocBook style. here is the sample.
http://hashfold.com/techfold/wordpress-how-to-generate-docbook-style-posts/