{"id":19912290,"url":"https://github.com/opticdev/demo","last_synced_at":"2026-03-19T12:24:41.567Z","repository":{"id":74944937,"uuid":"585120608","full_name":"opticdev/demo","owner":"opticdev","description":"Try Optic with this demo repo.","archived":false,"fork":false,"pushed_at":"2023-11-24T15:45:07.000Z","size":17,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-11T22:45:55.489Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/opticdev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-01-04T11:20:48.000Z","updated_at":"2024-12-31T08:14:47.000Z","dependencies_parsed_at":null,"dependency_job_id":"f8851e90-70c4-4c79-8be5-eb5491a2e868","html_url":"https://github.com/opticdev/demo","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opticdev%2Fdemo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opticdev%2Fdemo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opticdev%2Fdemo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/opticdev%2Fdemo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/opticdev","download_url":"https://codeload.github.com/opticdev/demo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241341722,"owners_count":19947104,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T21:28:56.705Z","updated_at":"2026-03-08T14:37:38.277Z","avatar_url":"https://github.com/opticdev.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Optic demo repository\nTry this demo repository to understand how Optic helps you work with OpenAPI specification files.\n\n## Setup\n### Cloud\nOpen the project in Gitpod with [this link](https://gitpod.io/#https://github.com/opticdev/demo) (open it in a new tab) and continue following the steps below in the pod's terminal.\n\n### Local\nAlternatively you can run the project in your local environment.\n\nClone this repository:\n```\ngit clone git@github.com:opticdev/demo.git optic-demo \u0026\u0026 cd optic-demo\n```\n\nThen install the Optic CLI:\n```\nnpm install -g @useoptic/optic\n```\n\n## Authenticate with Optic\nRun this command and follow the instructions to login with Optic.\n\nLogin will let you visualize docs and diffs in our web application:\n```\noptic login\n```\n\n## Add your first API to Optic\nNow that you're logged in, let's add the todo API to Optic:\n```\noptic api add todo-api.yaml\n```\n\nLet's check what has changed:\n```\ngit diff\n```\n\nA custom `x-optic-url` field was added to `todo-api.yaml`.\nThis tells Optic to take this specification in account.\n\nLearn more about the `optic api add` command with `optic api add --help`.\n\n## Visualize API documentation\nTime to push the spec and visualize the documentation in the Optic webapp:\n```\noptic spec push todo-api.yaml --web\n```\n\n## Visualize changes\nOptic can let you visualize changes between two versions of an API spec.\n\nLet's make a change to the todo API specification. For instance you could set the limit parameter to required: change `required: false` for `required: true` line 13 of `todo-api.yaml`.\n\nThen run optic diff. The `--web` flag lets Optic open the diff view in your browser:\n```\noptic diff todo-api.yaml --web\n```\n\n## Integrate with your CI\nOptic is perfectly suited to run in your CI.\n\nOnce in your own repository, run the following command and follow the wizard to start getting automatic docs and diff visualization for your pull request and start enforcing company standards to your OpenAPI specification files:\n```\noptic ci-setup\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopticdev%2Fdemo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopticdev%2Fdemo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopticdev%2Fdemo/lists"}