Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add optic for documentation #479

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add the Optic configuration and the vendor directory to store the API…
… Specification within
ukmadlz committed Jul 20, 2021

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
commit 6abdb417095b79343b80391a691b056763893e65
3 changes: 3 additions & 0 deletions .optic/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

captures/
optic-temp-*
1 change: 1 addition & 0 deletions .optic/api/specification.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
[]
16 changes: 16 additions & 0 deletions .optic/ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# Default Ignore Rules
# Learn to configure your own at http://localhost:4000/docs/using/advanced-configuration#ignoring-api-paths
OPTIONS (.*)
HEAD (.*)
GET (.*).htm
GET (.*).html
GET (.*).ico
GET (.*).css
GET (.*).js
GET (.*).woff
GET (.*).woff2
GET (.*).png
GET (.*).jpg
GET (.*).jpeg
GET (.*).svg
GET (.*).gif
13 changes: 13 additions & 0 deletions optic.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: "express-rest-es2017-boilerplate"
# Start your api with Optic by running 'api run <taskname>'
tasks:
start:
command: "yarn dev"
inboundUrl: http://localhost:4000

# Capture traffic from a deployed api by running 'api intercept <environment-name>'
# pass '--chrome' to capture from your browser's network tab
environments:
production:
host: https://api.github.com # the hostname of the API we should record traffic from
webUI: https://api.github.com/repos/opticdev/optic # the url that should open when a browser flag is passed