{"id":51150991,"url":"https://github.com/dev-ik/specdock","last_synced_at":"2026-06-26T06:01:40.725Z","repository":{"id":365719061,"uuid":"1271950533","full_name":"dev-ik/specdock","owner":"dev-ik","description":"Local-first OpenAPI workspace to import specs, test requests, and generate SDKs","archived":false,"fork":false,"pushed_at":"2026-06-18T14:15:02.000Z","size":594,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-18T16:14:53.408Z","etag":null,"topics":["api","api-client","api-testing","contract-testing","developer-tools","docker","fastify","local-first","openapi","openapi3","react","sdk-generator","self-hosted","swagger","typescript","vite"],"latest_commit_sha":null,"homepage":"https://specdock.ru","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/dev-ik.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":"docs/ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2026-06-17T06:41:59.000Z","updated_at":"2026-06-18T14:24:20.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/dev-ik/specdock","commit_stats":null,"previous_names":["dev-ik/specdock"],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/dev-ik/specdock","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-ik%2Fspecdock","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-ik%2Fspecdock/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-ik%2Fspecdock/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-ik%2Fspecdock/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dev-ik","download_url":"https://codeload.github.com/dev-ik/specdock/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dev-ik%2Fspecdock/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34805072,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-26T02:00:06.560Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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","api-client","api-testing","contract-testing","developer-tools","docker","fastify","local-first","openapi","openapi3","react","sdk-generator","self-hosted","swagger","typescript","vite"],"created_at":"2026-06-26T06:01:39.955Z","updated_at":"2026-06-26T06:01:40.712Z","avatar_url":"https://github.com/dev-ik.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SpecDock\n\n[![CI](https://github.com/dev-ik/specdock/actions/workflows/ci.yml/badge.svg)](https://github.com/dev-ik/specdock/actions/workflows/ci.yml)\n[![Release](https://img.shields.io/github/v/release/dev-ik/specdock?color=0f766e)](https://github.com/dev-ik/specdock/releases)\n[![Docker](https://img.shields.io/badge/docker-d8vik%2Fspecdock-2496ED?logo=docker\u0026logoColor=white)](https://hub.docker.com/r/d8vik/specdock)\n[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)\n\nLocal-first OpenAPI workspace to import specs, test requests, and generate SDKs.\n\nSpecDock keeps the everyday API contract loop in one browser workspace:\n\n```txt\nImport -\u003e Explore -\u003e Test -\u003e Generate\n```\n\nTry the hosted demo: [https://specdock.ru](https://specdock.ru)\n\n![SpecDock product preview](docs/assets/specdock-preview.svg)\n\n## What It Does\n\n- Import OpenAPI 3.0/3.1 and Swagger 2.0 specs from raw text, file upload, or URL.\n- Explore endpoints grouped by tags with search and operation details.\n- Compare two OpenAPI contracts explicitly and export Markdown or JSON diff reports.\n- Build requests with OpenAPI parameter serialization, JSON, form, multipart, binary bodies, cURL preview, and saved Base URL/Mode.\n- Store per-project auth profiles locally in the browser for repeat testing.\n- Execute requests in Direct Browser Mode or restricted self-hosted Proxy Mode.\n- Generate, save, and serve self-hosted mock responses when `MOCK_SERVER_ENABLED=true`.\n- Inspect saved request/response exchanges per endpoint or latest request.\n- Generate TypeScript, Python, Go, Java, C#, and PHP SDK files with basic naming presets and ZIP downloads.\n- Store projects, settings, safe request preferences, and history metadata in local browser storage.\n- Export/import local `.specdock.json` project files without auth secrets or request/response bodies.\n\nThe hosted demo is for evaluation. It does not provide unrestricted proxying for arbitrary third-party APIs. For controlled proxy execution, run SpecDock yourself and configure an explicit host allowlist.\n\n## Quick Start\n\nPrerequisites:\n\n```txt\nNode.js \u003e=20.19.0 \u003c21 or \u003e=22.13.0\nnpm\n```\n\nInstall and run:\n\n```bash\nnvm use\nnpm install\nnpm run dev\n```\n\nOpen:\n\n```txt\nhttp://127.0.0.1:5174\n```\n\nDemo OpenAPI spec:\n\n```txt\nhttp://127.0.0.1:5174/examples/specdock-demo-openapi.yaml\n```\n\n## Docker\n\nRun from source:\n\n```bash\ndocker compose up -d --build\n```\n\nRun the\n[published Docker Hub image](https://hub.docker.com/r/d8vik/specdock)\nwithout cloning the repository:\n\n```bash\ndocker run -d --name specdock \\\n  -p 127.0.0.1:3000:3000 \\\n  -e PUBLIC_DEMO=true \\\n  -e PROXY_ENABLED=false \\\n  docker.io/d8vik/specdock:v1.0.2\n```\n\nOr keep configuration in a local env file:\n\n```env\nPUBLIC_DEMO=false\nPROXY_ENABLED=true\nPROXY_ALLOWED_HOSTS=api.example.com,staging-api.example.com\nPROXY_ALLOW_PRIVATE_TARGETS=false\nMOCK_SERVER_ENABLED=false\n```\n\n```bash\ndocker run -d --name specdock \\\n  -p 127.0.0.1:3000:3000 \\\n  --env-file ./specdock.env \\\n  docker.io/d8vik/specdock:v1.0.2\n```\n\nIf you prefer Compose with the published image, create your own\n`docker-compose.yml`:\n\n```yaml\nservices:\n  specdock:\n    image: docker.io/d8vik/specdock:v1.0.2\n    ports:\n      - \"127.0.0.1:3000:3000\"\n    environment:\n      PUBLIC_DEMO: \"true\"\n      PROXY_ENABLED: \"false\"\n```\n\nOpen:\n\n```txt\nhttp://127.0.0.1:3000\n```\n\nCheck health:\n\n```bash\ncurl -fsS http://127.0.0.1:3000/api/health\n```\n\nUse immutable version tags such as `docker.io/d8vik/specdock:v1.0.2`; the project does not rely on `latest` for releases.\n\n## Desktop\n\nDownload desktop installers from [GitHub Releases](https://github.com/dev-ik/specdock/releases). The desktop app runs the SpecDock API on `127.0.0.1` with proxy and mock features disabled by default; `Settings -\u003e Desktop runtime` controls local mock/proxy settings. See [Desktop](docs/DESKTOP.md) for packaging and release workflow details.\n\nDesktop builds are unsigned. Verify `SHA256SUMS.txt` before bypassing platform\nwarnings. On macOS, clear quarantine with\n`sudo xattr -dr com.apple.quarantine /Applications/SpecDock.app` and run\n`open /Applications/SpecDock.app`. On Windows, SmartScreen can warn; use\n`More info -\u003e Run anyway` only after checksum verification. On Linux, make the\nAppImage executable with `chmod +x SpecDock*.AppImage` or use the `.tar.gz`.\n\n## Configuration\n\nPublic/demo deployments should keep backend proxy mode disabled:\n\n```env\nPUBLIC_DEMO=true\nDEMO_DIRECT_ALLOWED_HOSTS=dummyjson.com,petstore3.swagger.io,httpbin.org\nPROXY_ENABLED=false\n```\n\nWhen `PUBLIC_DEMO=true`, Direct Browser Mode is limited to\n`DEMO_DIRECT_ALLOWED_HOSTS`. Run SpecDock locally or self-host it to test\ncustom API hosts from the request builder.\n\nTrusted self-hosted deployments can enable restricted proxy mode:\n\n```env\nPUBLIC_DEMO=false\nPROXY_ENABLED=true\nPROXY_ALLOWED_HOSTS=api.example.com,staging-api.example.com\nPROXY_ALLOW_PRIVATE_TARGETS=false\nMOCK_SERVER_ENABLED=false\n```\n\nDo not enable unrestricted public proxying. Proxy requests are protected by explicit host allowlists, SSRF checks, header filtering, timeout limits, and request/response size limits. Self-hosted deployments should also use outbound firewall rules for internal networks.\n\nSelf-hosted mock responses are disabled by default. Set `MOCK_SERVER_ENABLED=true`\nonly on trusted self-hosted deployments. Public demo deployments ignore this\nflag and do not register mock routes. Saved mock routes are served under\n`/mock/...`, support OpenAPI path templates such as `/users/{id}`, and stay in\nmemory only while the API process is running.\n\nRun a contract diff from the CLI:\n\n```bash\nnpm run contract:diff -- old-openapi.yaml new-openapi.yaml\nnpm run contract:diff -- --format json --fail-on-breaking old.yaml new.yaml\n```\n\nWhen running behind a trusted loopback reverse proxy, set `TRUST_PROXY=loopback`.\nLeave it disabled for direct public exposure.\n\n## Development Checks\n\n```bash\nnvm use\nnpm run typecheck\nnpm run lint\nnpm run test\nnpm run test:sdk-smoke\nnpm run build\n```\n\n## SDK Generation\n\nSpecDock currently generates TypeScript SDKs with fetch or axios clients,\nPython SDKs with httpx clients, Go SDKs with the standard library, and Java\nSDKs with `java.net.http.HttpClient`, and C# SDKs with `HttpClient` plus\n`System.Text.Json`. It also generates PHP SDKs with Guzzle clients.\nGenerated SDK metadata includes the target runtime version for each language:\nTypeScript 5.x on Node.js 20+ or modern browsers, Python \u003e=3.11, Go 1.22,\nJava 17, .NET 8.0, and PHP \u003e=8.1.\n\n| Language | Runtime target | HTTP runtime |\n| --- | --- | --- |\n| TypeScript | TypeScript 5.x, Node.js 20+ or modern browsers | fetch or axios |\n| Python | Python \u003e=3.11 | httpx \u003e=0.27.0 |\n| Go | Go 1.22 | net/http |\n| Java | Java 17 | java.net.http + Jackson 2.17.2 |\n| C# | .NET 8.0 | HttpClient + System.Text.Json |\n| PHP | PHP \u003e=8.1 | Guzzle ^7.0 |\n\nEach generated SDK includes a `README.md` and `specdock.manifest.json` with\nthe selected language, runtime target, naming style, generator version, and\ngenerated file list. The smoke test generates every supported language and\nruns syntax/build checks when the matching runtime is available locally.\n\nThe generator roadmap keeps language-specific rendering behind shared\nOpenAPI-to-SDK planning, so generated clients remain predictable while each\nlanguage can use its native HTTP and typing conventions.\n\n## Repository Layout\n\n```txt\napps/api        Fastify API, proxy endpoint, generation endpoint, static web serving\napps/web        React/Vite web workspace\npackages/core   OpenAPI normalization, storage contracts, shared types\npackages/generator SDK generation\npackages/ui     Shared UI package placeholder\ndocs            Architecture, security, deployment, smoke tests, and roadmap\n```\n\n## Documentation\n\nStart with the [master plan](docs/SPECDOCK_MASTER_PLAN.md),\n[implementation plan](docs/IMPLEMENTATION_PLAN.md),\n[security guide](SECURITY.md), [release checklist](docs/RELEASE.md), and\n[roadmap](docs/ROADMAP.md).\n\n## Open-Source Hygiene\n\nDo not commit local credentials, private proxy targets, provider-specific\nhosting entrypoints, or generated build output.\n\n## License\n\nSpecDock is released under the [MIT License](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-ik%2Fspecdock","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdev-ik%2Fspecdock","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdev-ik%2Fspecdock/lists"}