GithubHelp home page GithubHelp logo

isabella232 / nelmioapidocbundle Goto Github PK

View Code? Open in Web Editor NEW

This project forked from nelmio/nelmioapidocbundle

0.0 0.0 0.0 14.59 MB

Generates documentation for your REST API from annotations

License: MIT License

PHP 96.95% JavaScript 0.39% Shell 0.19% CSS 1.41% Batchfile 0.01% Twig 1.06%

nelmioapidocbundle's Introduction

NelmioApiDocBundle

Build Status Total Downloads Latest Stable Version

The NelmioApiDocBundle bundle allows you to generate a decent documentation for your APIs.

Migrate from 3.x to 4.0

To migrate from 3.x to 4.0, follow our guide.

Version 4.0 brings OpenAPI 3.0 support. If you want to stick to Swagger 2.0, you should use the version 3 of this bundle.

Migrate from 2.x to 3.0

To migrate from 2.x to 3.0, follow our guide.

Installation

Open a command console, enter your project directory and execute the following command to download the latest version of this bundle:

composer require nelmio/api-doc-bundle

Documentation

Read the documentation on symfony.com

Contributing

See CONTRIBUTING file.

Running the Tests

Install the Composer dependencies:

git clone https://github.com/nelmio/NelmioApiDocBundle.git
cd NelmioApiDocBundle
composer update

Then run the test suite:

./phpunit

License

This bundle is released under the MIT license.

nelmioapidocbundle's People

Contributors

guilhemn avatar goetas avatar dbu avatar phansys avatar magnetik avatar bifidokk avatar zdenekdrahos avatar chrisguitarguy avatar deluxetom avatar kopaygorodsky avatar derrabus avatar piotrantosik avatar mantis avatar quentin-st avatar maxhelias avatar notfloran avatar filipbenco avatar akalineskou avatar markuspoerschke avatar koriseng avatar cyberemissary avatar maninthebox avatar saleh199 avatar martijnvankempen avatar javiereguiluz avatar bafs avatar discordier avatar jlekowski avatar katin-dev avatar copiri-six avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.