Generating REST documentation in a Codeigniter project
Asked Answered
S

2

10

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.

Supportable answered 5/2, 2015 at 9:59 Comment(0)
P
8

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.

Pawl answered 28/4, 2016 at 19:40 Comment(0)
V
0

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

Viviennevivify answered 19/8, 2021 at 5:40 Comment(1)
Link only answers are considered very low quality and can get deleted, please put the important parts from the linked resource into the answer body.Christianachristiane

© 2022 - 2024 — McMap. All rights reserved.