{"id":15101380,"url":"https://github.com/devjack/example-library-specification","last_synced_at":"2026-01-29T04:51:20.291Z","repository":{"id":71838710,"uuid":"151935342","full_name":"devjack/example-library-specification","owner":"devjack","description":"Using OpenAPI and JSON Schema to build a design-first API","archived":false,"fork":false,"pushed_at":"2018-10-07T13:20:16.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-01T18:15:44.103Z","etag":null,"topics":["api","json","jsonschema","openapi","openapi-spec","openapi-specification","openapi3","rest-api","restful-api","speccy"],"latest_commit_sha":null,"homepage":"","language":"HTML","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/devjack.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":"2018-10-07T11:41:30.000Z","updated_at":"2021-11-30T21:32:02.000Z","dependencies_parsed_at":null,"dependency_job_id":"758c55f6-bd59-43e3-9139-62b2de83bf2c","html_url":"https://github.com/devjack/example-library-specification","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/devjack%2Fexample-library-specification","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjack%2Fexample-library-specification/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjack%2Fexample-library-specification/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/devjack%2Fexample-library-specification/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/devjack","download_url":"https://codeload.github.com/devjack/example-library-specification/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245858880,"owners_count":20684057,"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":["api","json","jsonschema","openapi","openapi-spec","openapi-specification","openapi3","rest-api","restful-api","speccy"],"created_at":"2024-09-25T18:21:27.028Z","updated_at":"2026-01-29T04:51:20.253Z","avatar_url":"https://github.com/devjack.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Example Library Specification\nThis repository defines a simple API using [OpenAPI v3.0.1](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md).\n\n[![Build Status](https://travis-ci.org/devjack/example-library-specification.svg?branch=master)](https://travis-ci.org/devjack/example-library-specification)\n\n# Setup and installation\n\nThe API spec is defined in `openapi.yml`. Each URL has its own endpoint in `endpoints/` and JSON request/response schemas are defined in `schemas/`. JSON Schema is used to define responses and can be used for validation.\n\n## Setup and run the documentation\nRun these commands to install npm dependencies and serve the API documentation locally.\n\n```sh\nnpm install\nnpm run test\nnpm run serve\n```\n\nThe API documentation will be available at [https://localhost:5000](http://localhost:5000).\n\nTo resolve and publish the API spec, run:\n\n```sh\nnpm run resolve\n```\n\nA simple HTML document including [ReDoc](https://github.com/Rebilly/ReDoc) is available in the `public/` directory. To copy across the published spec and schemas, run:\n\n```sh\nnpm run publish\n```\n\nYou can then serve `/public` from any static content hosting service. The current documentation is hosted on Netlify at [example-library-specification.netlify.com](https://example-library-specification.netlify.com)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevjack%2Fexample-library-specification","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdevjack%2Fexample-library-specification","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdevjack%2Fexample-library-specification/lists"}