Download the PHP package woohoolabs/spec-generator without Composer
On this page you can find all versions of the php package woohoolabs/spec-generator. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download woohoolabs/spec-generator
More information about woohoolabs/spec-generator
Files in woohoolabs/spec-generator
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package spec-generator
Woohoo Labs. Spec Generator
Generate various specifications (e.g. Swagger Spec 2.0) in perfect sync with your real code via object-oriented PHP!
Introduction
This library aims to foster creating configurations and specifications which would be written in structured data formats (like JSON, XML, YML). Not only these files can grow extremely long, but they can easily become a nightmare from a maintenance point of view. For example, let's take the Swagger 2.0 specification: the documentation of an API with only a handful of resources can easily go over one thousand of lines. That's why it requires a great effort to have a good overview on the document.
Another problem is that the live software and its specification usually diverges from each other over time as the maintaining staff is too busy/negligent/forgetful to synchronize them. Woohoo Labs. Spec Generator tries to shorten the gap between them: the main idea is to generate documents supported by the glorious object-oriented features right from your application's code!
When talking about creating documentations, you could ask what the point is in writing these documents by hand, when some of them (e.g. Swagger docs) could be generated by frameworks which use annotations for the definitions. While this is a valid point, there are yet some major drawbacks of this approach (it is called reverse-engineering):
- It is not forward-engineering: Sometimes you need to design something before you ship it :)
- Your specification/documentation will be fragmented: there won't be any single place to look for these definitions. That's why if you need to change something in multiple places then it won't be easy.
- You won't benefit from the capabilities of PHP: You can't extend classes, can't read data from files or even constants, can't have code completion from your IDE etc. This undermines real consistency.
Features
- Support for Swagger 2.0 API documentation
- Different output formats (array, JSON, XML, YML)
- Specification can be cached for improved performance
Basic Usage
Advanced Usage
Caching
License
The MIT License (MIT). Please see the License File for more information.
All versions of spec-generator with dependencies
doctrine/cache Version ^1.4.0
jms/serializer Version ^0.16.0
symfony/yaml Version ^2.5.0