Setting up an API from an OpenAPI 3 description file in 3 Minutes.
Following the instructions at https://github.com/cebe/yii2-app-api#setup
The OpenAPI 3 description file is the Petstore example from https://raw.githubusercontent.com/OAI/OpenAPI-Specification/3.0.2/examples/v3.0/petstore.yaml
- Automatically implements CRUD operations
- adds placeholders for specific endpoints
The last example throws a 404, while it should be 405, that still needs to be fixed :)
Share this recording
Link
Append ?t=30 to start the playback at 30s, ?t=3:20 to start the playback at 3m 20s.
Embed image link
Use snippets below to display a screenshot linking to this recording.
Useful in places where scripts are not allowed (e.g. in a project's README file).
HTML:
Markdown:
Embed the player
If you're embedding on your own page or on a site which permits script tags, you can use the full player widget:
Paste the above script tag where you want the player to be displayed on your page.
See embedding docs for additional options.
Download this recording
You can download this recording in asciicast v2 format, as a .cast file.
DownloadReplay in terminal
You can replay the downloaded recording in your terminal using the
asciinema play
command:
asciinema play 253737.castIf you don't have asciinema CLI installed then see installation instructions.
Use with stand-alone player on your website
Download asciinema player from
the releases page
(you only need .js
and .css
file), then use it like this:
<!DOCTYPE html>
<html>
<head>
<link rel="stylesheet" type="text/css" href="asciinema-player.css" />
</head>
<body>
<div id="player"></div>
<script src="asciinema-player.min.js"></script>
<script>
AsciinemaPlayer.create(
'/assets/253737.cast',
document.getElementById('player'),
{ cols: 211, rows: 56 }
);
</script>
</body>
</html>See asciinema player quick-start guide for full usage instructions.
Generate GIF from this recording
While this site doesn't offer GIF conversion at the moment, you can still do it yourself with the help of asciinema GIF generator utility - agg.
Once you have it installed run the following command to create GIF file:
agg https://asciinema.org/a/253737 253737.gifOr, if you already downloaded the recording file:
agg 253737.cast 253737.gifCheck agg --help for all available options. You can change font
family and size, select color theme, adjust speed and more.
See agg manual for full usage instructions.