# Laravel Swagger Demo

This demonistrates how to integrate Swagger into a Laravel project.

## :question: Why use Swagger? 

## :books: Resources
- [Swagger annotation reference](https://gist.github.com/nostah/d610459d50564c729c56)
- [Doctrine Annotations reference](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/annotations-reference.html)

## :sweat_drops: TODO

### Sections
- [ ] Why use Swagger?
- [ ] Difference between generating Swagger docs on Laravel & Symfony.
- [ ] Good annotation practices.
- [ ] Where to place annotations.
- [ ] A working demo (deployed thru either Beanstalk or Forge).

### Technical
- [ ] Annotation proper.
- [ ] Artisan commands.
- [ ] Laravel passport.
- [ ] A working demo (deployed thru either Beanstalk or Forge).

# Laravel Swagger Demo

This demonistrates how to integrate [Swagger](http://swagger.io/) into a Laravel project.

## :open_mouth: What is Swagger?

According [to their own blog post](http://swagger.io/getting-started-with-swagger-i-what-is-swagger/):

[...]
> Swagger is a set of rules (in other words, a specification) for a format **describing REST APIs**. The format is both machine-readable **and human-readable**. As a result, it can be used to **share documentation** among **product managers, testers and developers**, but can also be used by various tools to automate API-related processes.

## :books: Resources
- [Swagger annotation reference](https://gist.github.com/nostah/d610459d50564c729c56)
- [Doctrine Annotations reference](http://docs.doctrine-project.org/projects/doctrine-orm/en/latest/reference/annotations-reference.html)

## :sweat_drops: TODO

### Sections
- [ ] Why use Swagger?
- [ ] Difference between generating Swagger docs on Laravel & Symfony.
- [ ] Good annotation practices.
- [ ] Where to place annotations.
- [ ] A working demo (deployed thru either Beanstalk or Forge).

### Technical
- [ ] Annotation proper.
- [ ] Artisan commands.
- [ ] Laravel passport.
- [ ] A working demo (deployed thru either Beanstalk or Forge).

Add "What is Swagger" section
Add "What is Swagger" section