API Documentation generator for the Yii framework 2.0
Swagger Markdown Live Demo. Readme.io is a multi-purpose software documentation generator that powers many API developer hubs. It comes with a Markdown-based editor, versioning support, an API explorer to demonstrate sample calls, and crowdsource features where users can suggest API changes.
The apidoc.md document described the details of the markdown format. The Apidoc Documentation Set. The set of systems that apidoc knows about are those described by the apidoc files in the apidoc folder. Any valid file dropped in this folder will be automatically incorporated into the set and presented on the apidoc website. RESTful web API Documentation Generator. Contribute to apidoc/apidoc development by creating an account on GitHub.
Oct 11, 2020 ReDoc leverages markdown headings. It enables deep linking and high-level grouping via vendor extension in the side menu. ApiDoc allows you to create documentations out of API annotations easily in the source code. It provides the flexibility of attaching a version number for your APIs and helps you track changes made between versions. After editing the markdown file, you can use the apidoc:rebuild command to rebuild your documentation into HTML.
Maintainers
Details
Fund package maintenance!
yiisoft
Open Collective
Tidelift
Installs: 406 048
Dependents: 44
Suggesters: 0
Security: 0
Stars: 237
Watchers: 33
Forks: 113
Open Issues: 45
Type:yii2-extension
Requires
- php: >=5.4
- cebe/js-search: ~0.9.3
- cebe/markdown: ~1.0.0 | ~1.1.0 | ~1.2.0
- cebe/markdown-latex: ~1.0
- nikic/php-parser: ^1.0
- phpdocumentor/reflection: ^3.0.1
- phpdocumentor/reflection-docblock: ^2.0.4
- scrivo/highlight.php: ~9.13
- yiisoft/yii2: ~2.0.13
- yiisoft/yii2-bootstrap: ~2.0.0
Replaces
None
This package is auto-updated.
Last update: 2021-04-09 12:18:36 UTC
This extension provides an API documentation generator for the Yii framework 2.0.
For license information check the LICENSE-file.
Installation
The preferred way to install this extension is through composer.
Either run
The above command may not work on an existing project due to version conflicts that need to be resolved, so it is preferred to add the package manually to the require section of your composer.json:
afterwards run composer update. You may also run composer update yiisoft/yii2-apidoc cebe/markdown if you want to avoid updating unrelated packages.
Usage
This extension offers two commands:
apito generate class API documentation. phpDocumentor is used as a base frameworkso refer to its guide for the syntax.guideto render nice HTML pages from markdown files such as the yii guide.
Simple usage for stand-alone class documentation:
Simple usage for stand-alone guide documentation:
You can combine them to generate class API and guide documentation in one place:
By default, the bootstrap template will be used. You can choose a different template with the --template=name parameter.Currently, there is only the bootstrap template available.
You may also add the yiiapidoccommandsApiController and GuideController to your console application command mapand run them inside of your applications console app.
Generating docs from multiple sources
The apidoc generator can use multiple directories, so you can generate docs for your application and include the yii frameworkdocs to enable links between your classes and framework classes. This also allows @inheritdoc to workfor your classes that extend from the framework.Use the following command to generate combined api docs:
This will read the source files from ./vendor/yiisoft/yii2 directory and . which is the current directory (you may replace this with the location of your code if it is not in the current working directory).
Advanced usage
The following script can be used to generate API documentation and guide in different directories and also multiple guidesin different languages (like it is done on yiiframework.com):
Creating a PDF of the guide
You need pdflatex and GNU make for this.
Apidoc Markdown File
If all runs without errors the PDF will be guide.pdf in the output dir.
Special Markdown Syntax
We have a special Syntax for linking to classes in the API documentation.See the code style guide for details.
Creating your own templates
TBD
Using the model layer
TBD
Do you need to create API docs for your RESTful API? Want to automatically generate API documentation? Today, I am going to share some free templates that are designed to showcase your API. Good documentation is reallyimportant so start with a good foundation. These API resources are simple, clean, leverage best practices, and will make your API users happy.
1. Slate – helps you create beautiful API documentation. It’s responsive, uses Markdown and Ruby, and it’s inspired by Stripe’s and Paypal’s API docs. Here is a demo.
2. apiDoc – inline documentation for RESTful web APIs that is created from API annotations in your source code. The theme is 2 columns and here is a demo.
3. FlatDoc – makes writing documentation easy. There is no built process, just a small JavaScript file that fetches Markdown files and renders them as full pages. You create documentation from Readme files. The default theme is responsive and you can deploy via Github Pages.
4. Webservice API Specification Doc Template – easy, simple, clean API doc template built as a Google Doc page.
5. API Blueprint – gives you awesome tools for your whole API lifecycle. You can generate documentation automatically and much more with this tool. Here are some examples. Also, check out aglio, the API blueprint renderer.
6. Swagger – simple and powerful interface to your API. Lots of automation, API tooling, and even client SDK generation and discoverability. Check out the live demo.
Apidoc Markdown Schedule
7. Calamum – generates REST API documentation from a JSON file. It has a twitter template and a bootstrap template.
8. miredot is a REST API documentation generator for Java. Check out the example.
Api Doc Markdown Example
9. RAML – simple and succinct way of describing RESTful APIs. It’s built on broadly-used standards such as YAML and JSON and it has many tools, one of which is RAML to HTML which output documentation based on RAML files.
10. RestDoc – PHP scripts to generate REST documentation from YAML files.
External
Apidoc Markdown Table
Beautiful Docs
Read the Docs
readme.io
APIary
Doxygen
Dexy
iodocs
Docco