infyomlabs / swagger-generator

Swagger Generator & Templates for InfyOm Laravel Generator

Swagger Generator for InfyOm Laravel Generator

Generate Swagger Docs for APIs along with Generating CRUD APIs with InfyOm Laravel Generator.

Documentation

Read Documentation for detailed installation steps and usage.

Support Us

We have created 14+ Laravel packages and invested a lot of resources into creating these all packages and maintaining them.

You can support us by either sponsoring us or buying one of our paid products. Or help us by spreading the word about us on social platforms via tweets and posts.

Buy our Paid Products

You can also check out our other paid products on CodeCanyon.

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site.

Backers

Become a backer and get your image on our README on Github with a link to your site.

Follow Us

• Twitter
• Facebook
• LinkedIn
• Youtube
• Contact Us

Made with InfyOm Generator

Also, Do not forget to add your website to Made with InfyOm Generator List list.

Security

If you discover any security-related issues, create an issue using the issue tracker.

Credits

• InfyOm Technologies
• All Contributors

License

The MIT License (MIT). Please see License File for more information.

swagger-generator's Issues

laravel-generator Version Matching Problem

• laravel: ^7.0
• infyomlabs/laravel-generator: ^2.0
• infyomlabs/swagger-generator: ^2.0

This is the version that I saw in the document.But he can't generate documents properly.
swagger generator property.stub

 *      @OA\Property(
 *          property="$FIELD_NAME$",
 *          description="$DESCRIPTION$",
 *          readOnly=$FIELD_READ_ONLY$,
 *          nullable=$FIELD_NULLABLE$,
 *          type="$FIELD_TYPE$"$FIELD_FORMAT$
 *      )

$FIELD_READ_ONLY$ and $FIELD_NULLABLE$, Not replaced

add support for OpenAPI spec v3 annotation

Hello, great work with the Swagger generator

So the appointer/swaggervel is archived by the owner. It is now read-only.

I opted to use https://github.com/DarkaOnLine/L5-Swagger as the generator ,

Now "darkaonline/l5-swagger" latest version that is 8 is compatible with OpenAPI Spec version 3 only,

This package has only "@swg (SWAGGER annotations) support." stubs it would be nice to have OpenAPI spec v3 annotation (@OA)

Model swagger docs should have 2 definitions: 1 for writeable only and 1 for all

Each model should have 2 definitions. The first definition will contain only writeable by user properties and the second definition will contain all properties with reference to writeable ones.

This helps to tell API consumers to send only writeable properties to CREATE & UPDATE request in Swagger UI.

Example of swagger definitions.

/**
 * @SWG\Definition(
 *      definition="Project:write",
 *      required={"name"},
 *      @SWG\Property(
 *          property="name",
 *          description="name",
 *          type="string"
 *      ),
 *      @SWG\Property(
 *          property="description",
 *          description="description",
 *          type="string"
 *      ),
 *      @SWG\Property(
 *          property="starts_at",
 *          description="starts_at",
 *          type="string",
 *          format="date-time"
 *      ),
 *      @SWG\Property(
 *          property="ends_at",
 *          description="ends_at",
 *          type="string",
 *          format="date-time"
 *      ),
 *      @SWG\Property(
 *          property="expertise_id",
 *          description="expertise_id",
 *          type="integer",
 *          format="int32"
 *      ),
 *      @SWG\Property(
 *          property="user_id",
 *          description="user_id",
 *          type="integer",
 *          format="int32"
 *      )
 * )
 *
 * @SWG\Definition(
 *      definition="Project",
 *      required={"name"},
 *      allOf={
 *          @SWG\Schema(ref="#/definitions/Project:write")
 *      },
 *      @SWG\Property(
 *          property="id",
 *          description="id",
 *          type="integer",
 *          format="int32"
 *      ),
 *      @SWG\Property(
 *          property="created_at",
 *          description="created_at",
 *          type="string",
 *          format="date-time"
 *      ),
 *      @SWG\Property(
 *          property="updated_at",
 *          description="updated_at",
 *          type="string",
 *          format="date-time"
 *      )
 * )
 */
`
``

SS for Swagger UI of CREATE endpoint
![image](https://user-images.githubusercontent.com/2726365/79454217-8007d980-7ff3-11ea-8298-050a31e18070.png)

Base path not absolute in base controller.

The swagger docs in the base controller specify 'api/v1' and this eliminates the slash between the base path and the doc path resulting in http://myapp.comapi/v1

Error generating Swagger using Generator Builder

×Fail! file_get_contents(E:\Work\APP_Project\ti-hrm\vendor/infyomlabs/swagger-generator/templates/model_docs/model.stub): Failed to open stream: No such file or directory

get this error when selecting swagger on Generator Builder

Everytime I try to view there is an error

crud.com/api/docs

💥 retruns

ErrorException in Logger.php line 38:
Required @SWG\Info() not found

crud.com/docs

💥 retruns

Cannot find /home/vagrant/grace/local.start/storage/docs/api-docs.json

_Do we need to run a swagger command or something?_

Also the view file that is imported into the views/vendor/ area is formatted incorrectly.

Here is part of

resources/views/vendor/jlapp/swaggervelsrc/views/index.blade.php

    <link rel="icon" type="image/png" href="/vendor/swaggervel/images/favicon-32x32.png" sizes="32x32" />
        <link rel="icon" type="image/png" href="/vendor/swaggervel/images/favicon-16x16.png" sizes="16x16" />
        <link href='/vendor/swaggervel/css/typography.css' media='screen' rel='stylesheet' type='text/css'/>
        <link href='/vendor/swaggervel/css/reset.css' media='screen' rel='stylesheet' type='text/css'/>
        <link href='/vendor/swaggervel/css/screen.css' media='screen' rel='stylesheet' type='text/css'/>
        <link href='/vendor/swaggervel/css/reset.css' media='print' rel='stylesheet' type='text/css'/>
        <link href='/vendor/swaggervel/css/print.css' media='print' rel='stylesheet' type='text/css'/>
        <script src='/vendor/swaggervel/lib/jquery-1.8.0.min.js' type='text/javascript'></script>
        <script src='/vendor/swaggervel/lib/jquery.slideto.min.js' type='text/javascript'></script>
        <script src='/vendor/swaggervel/lib/jquery.wiggle.min.js' type='text/javascript'></script>
        <script src='/vendor/swaggervel/lib/jquery.ba-bbq.min.js' type='text/javascript'></script>
        <script src='/vendor/swaggervel/lib/handlebars-2.0.0.js' type='text/javascript'></script>
        <script src='/vendor/swaggervel/lib/underscore-min.js' type='text/javascript'></script>
        <script src='/vendor/swaggervel/lib/backbone-min.js' type='text/javascript'></script>
        <script src='/vendor/swaggervel/swagger-ui.js' type='text/javascript'></script>
        <script src='/vendor/swaggervel/lib/highlight.7.3.pack.js' type='text/javascript'></script>
        <script src='/vendor/swaggervel/lib/marked.js' type='text/javascript'></script>

        <script src='/vendor/swaggervel/lib/swagger-oauth.js' type='text/javascript'></script>

        <!-- Some basic translations -->
        <!-- <script src='lang/translator.js' type='text/javascript'></script> -->
        <!-- <script src='lang/ru.js' type='text/javascript'></script> -->
        <!-- <script src='lang/en.js' type='text/javascript'></script> -->

Change into something like

 <link rel="icon" type="image/png" href="{!! url('/vendor/swaggervel/images/favicon-32x32.png') !!}" sizes="32x32" />
        <link rel="icon" type="image/png" href="{!! url('/vendor/swaggervel/images/favicon-16x16.png') !!}" sizes="16x16" />
        <link href='{!! asset('/vendor/swaggervel/css/typography.css') !!}' media='screen' rel='stylesheet' type='text/css'/>
        <link href='{!! asset('/vendor/swaggervel/css/reset.css') !!}' media='screen' rel='stylesheet' type='text/css'/>
        <link href='{!! asset('/vendor/swaggervel/css/screen.css') !!}' media='screen' rel='stylesheet' type='text/css'/>
        <link href='{!! asset('/vendor/swaggervel/css/reset.css') !!}' media='print' rel='stylesheet' type='text/css'/>
        <link href='{!! asset('/vendor/swaggervel/css/print.css') !!}' media='print' rel='stylesheet' type='text/css'/>
        <script src='{!! asset('/vendor/swaggervel/lib/jquery-1.8.0.min.js') !!}' type='text/javascript'></script>
        <script src='{!! asset('/vendor/swaggervel/lib/jquery.slideto.min.js') !!}' type='text/javascript'></script>
        <script src='{!! asset('/vendor/swaggervel/lib/jquery.wiggle.min.js') !!}' type='text/javascript'></script>
        <script src='{!! asset('/vendor/swaggervel/lib/jquery.ba-bbq.min.js') !!}' type='text/javascript'></script>
        <script src='{!! asset('/vendor/swaggervel/lib/handlebars-2.0.0.js') !!}' type='text/javascript'></script>
        <script src='{!! asset('/vendor/swaggervel/lib/underscore-min.js') !!}' type='text/javascript'></script>
        <script src='{!! asset('/vendor/swaggervel/lib/backbone-min.js') !!}' type='text/javascript'></script>
        <script src='{!! asset('/vendor/swaggervel/swagger-ui.js') !!}' type='text/javascript'></script>
        <script src='{!! asset('/vendor/swaggervel/lib/highlight.7.3.pack.js') !!}' type='text/javascript'></script>
        <script src='{!! asset('/vendor/swaggervel/lib/marked.js') !!}' type='text/javascript'></script>

        <script src='{!! asset('//vendor/swaggervel/lib/swagger-oauth.js') !!}' type='text/javascript'></script>

        <!-- Some basic translations -->
        <!-- <script src='{!! asset('/vendor/swaggervel/lang/translator.js') !!}' type='text/javascript'></script> -->
        <!-- <script src='{!! asset('/vendor/swaggervel/lang/ru.js') !!}' type='text/javascript'></script> -->
        <!-- <script src='{!! asset('/vendor/swaggervel/lang/en.js') !!}' type='text/javascript'></script> -->

appointer/swaggervel This package is abandoned and no longer maintained. No replacement package was suggested.

**appointer/swaggervel package is no more maintained or abondoned.

Way to customize swagger route path

Hello.
Is there a way to customize templates using MODEL_NAME_PLURAL_SNAKE instead of MODEL_NAME_PLURAL_CAMEL? (like I did in https://github.com/webdevog/swagger-generator)
I can't find a way to configure it.
My issue is that infyomlabs/laravel-generator generates by default routes in snake_case style and infyomlabs/swagger-generator makes swagger annotations using camelCase and as result I have wrond routes in documentation until I start using my fork master...webdevog:master
Any suggestions?
Thank you