f2m2 / apidocs Goto Github PK

Hello, How I handle object parameter for example
@param object $user Required ?

Will this plugin supports Laravel 5.2 in the future?

Right now I tried to run php artisan apidocs:generate but it returns the following error:
Fatal error: Call to undefined method Illuminate\Routing\Route::beforeFilters().

It seems that Illuminate\Routing\Route::beforeFilters() is removed in 5.2. Any thoughts?

Hello,

thanks for this implementation for Laravel!

I#ve got a question about the usage of your plugin. Ill installed it like in your description, and when ill run php artisan it tells me "Api Docs have been generated!"

But there are no docs generated - my config the:
'view_target_path' => app_path('views'),
should be fine. But there are no docs. Do i need some more configuration?

Thanks in advance,
Dieter

Hello,

is there any possibility to work with routing controller like:
Route::Controller('style', 'Api\ApiStyleController');

My structure is like
Api\ApiController -> this file handles requests and redirect to specific Controller , but when I do something like this:

    Route::group(['prefix' => 'api/'], function(){
         Route::Controller('style', 'Api\ApiStyleController');
         Route::Controller('account', 'Api\ApiAccountController');

    });

ApiDocs generate ApiStyle, ApiAccount but with methods from ApiController , don't know why :|

Edit 1:
As I see the problem is that my:
\Api\ApiStyleController extens \Api\ApiController, and APiDocs show only methods from ApiController, not from ApiStyleController, why ?

Edit 2:
As I see when I rename my methods to post/get etc like anyStyles in Api/ApiStyleController , I see methods from ApiController and this method form ApiStyleController, but I don't want to change methods names. Is this possible ?

How can I do that?
Best Regards,
Mateusz

API Docs aren't generated when using the Dingo/API, this probably has something to do with the Route::api being the route grouping override

Route::api(['version' => 'v1'], function () {

versus

Route::group(['prefix' => 'api/v1'], function(){

When I generate the docs for CRUD methods which involve ID parameter in the URL, like the DocBlock example you have given in the README.md, the form generated in the doc doesn't work.

/**
* Display the specified resource.
* GET /user/{id}
*
* @param  int  $id  The id of a User
* @return Response
*/
public function show($id)
{
    // Display User
}

Hi there,

Can you please add support for Laravel 6?

Thanks!

Hello there,

I think you got the version wrong on the first step of the Laravel 4.2 installation. You said to add this to the composer.json file:
"f2m2/apidocs": "dev-master"

I checked on packagist just to make sure because it wasn't working, and tried puting this:
"f2m2/apidocs": "1.*"
It still didn't work, so I tried it with
"f2m2/apidocs": "1.0"
and it's still not working.
The error I'm getting is:

Problem 1
- Installation request for f2m2/apidocs 1.0 -> satisfiable by f2m2/apidocs[1.0].
- f2m2/apidocs 1.0 requires illuminate/support 4.2.* -> satisfiable by illuminate/support[4.2.x-dev, v4.2.0-BETA1, v4.2.1, v4.2.12, v4.2.16, v4.2.17, v4.2.2, v4.2.3, v4.2.4, v4.2.5, v4.2.6, v4.2.7, v4.2.8, v4.2.9] but these conflict with your requirements or minimum-stability.

I'm on laravel version 4.2.19, could I get some help ?

thanks you !

When i try this. F2m2 generate APIDocs for all my route. Can i define some specific route? by prefix maybe?

Hi.
I have tried making documentation for my project, but it won't update.
The initial generation went fine and i got my documentation. But if i make changes, they dont show.
I have tried to shut down the server, then run php artisan apidocs:generate, and then restart the server. No luck. Do you have an idea what's wrong?
Another thing, is it possible to make other types of annotations? Like header parameters and queryparams?
Otherwise awesome library :)

Does this support Laravel 5.1? I cannot install through composer due to the composer dependency restrictions

Hi,

I generated the api docs successfully, I can see the list of all the APIs with the descriptions, but when I click on "Generate example response" i always get a 404 error

That happens on all the API endpoints I have, even if the end point works fine and returns a json object.
When I try it in my localhost, it works perfectly.

How can I solve this?

Thanks!

Is there a way to Generate doc for dynamic links ?

eg.api/v1/link/{id}

Does this work with Lumen as well?

Eg:

/**
 * Register a new user
 * POST /authenticate/create
 *
 * @param string $firstName => (Marked as optional)
 * @param string $lastName
 * @param string $email => (Marked as required)
 * @param string $password
 * @param int $gender
 * @param date(yyyy-mm-dd) $birthday 
 *
 * @return response contain object user
 */
public function register() {

Thanks,

I got error and can't generate docs:

What is the API Prefix? i.e. "api/v1":

api/v1

Generating api/v1 API Documentation.

[ErrorException]
Uninitialized string offset: 0

Hello,

when ill try to use:
* @return int test to return something
Ill dont see any changes in the result. Which properties are supported?

For me only comments and @param is working? Is that correct, or do i something wrong?
Thanks in advance.

I want group 2 group: API For App and API for POS
Do you help me ?

I research but i not found it.

Thanks you very much.

I need to add authorisation token in the header of request.
E.g. Authentication: Bearer "abc".

Is there any way to do it?

I'm unable to generate API on laravel 5.5 (Fresh install)

[ReflectionException]
Method F2m2\Apidocs\Commands\ApiDocsGeneratorCommand::handle() does not exist

Please help

Hi.

Is there a reason that you are using so old a version of reflection-docblock? You are depending on version 2.0 ish, and they are up to 4.3 atleast.

¿This version is compatible with laravel 5.1?

Hello,

I see mistake in readme.
Seem 'F2m2\Apidocs\ApidocsServiceProvider' niot correct namespace.
You should better use this one
Fontenele\Apidocs\ApidocsServiceProvider

Regards,
Dmitry

Thanks for the generator!
Could you pleas help me with POST params description?
@param works fine, but it looks ugly.

Hello,

The website is in https, and each time I run the commande: apidocs:generate is overriding my includes/docs/api/head.blade.php and putting the asset( instead of the secure_asset(.

Can you please add an option to not override the head? or and option to enable the secure_asset?

Thank you,

Hello love your work but how do I documenbt JSON based api ? the parameters are in JSON not sure who to write that?

thanks

For now, it just support for Laravel 5 only:

f2m2/apidocs dev-master requires illuminate/support 5.* -> satisfiable by illuminate/support[v5.0.0, v5.0.22, v5.0.25, v5.0.26, v5.0.28, v5.0.33, v5.0.4, v5.1.1, v5.1.13, v5.1.16, v5.1.2, v5.1.20, v5.1.22, v5.1.25, v5.1.6, v5.1.8].

My application runs with laravel5.1 and wants to have a try with this apidocs.
When i ran php artisan apidocs:generate, it gave me:
[Illuminate\Contracts\Filesystem\FileNotFoundException]
File does not exist at path vendor/f2m2/apidocs/src/templates/docs/index.blade.php

i manually created this file but the error still there.
Any help?

Hello, super cool package, but i have an problem that i hope you can solve.
Everything works great when i deploy my APIs to nginx and the API sits in the root folder.

Since we version our APIs by url, I tried to install the api documentation in our /v1.2 subfolder, and it breaks all the CSS and JS paths.

You can see it here: https://spokes.veloguide.com/v1.2/docs

How can it be resolved? It looks like the generated view is using some hardcoded relative paths instead of using asset('my_path')