Skip to content

Latest commit

 

History

History

docs

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
app
app
 
 
lib
lib
 
 
README.md
README.md
 
 
TODO.md
TODO.md
 
 
next.config.js
next.config.js
 
 
package.json
package.json
 
 

README.md

Mosque.API — Documentation site

Comprehensive, interactive documentation at docs.mosque.api: getting started, Try it (live requests), full API reference (OpenAPI/Swagger), Examples (cURL, JavaScript, Python), authentication, errors, and pagination.

Doc toolbar (every doc page): Copy markdown, Ask AI (copy prompt), Ask Claude (copy + open claude.ai), Ask OpenAI (copy + open chat.openai.com). Use HTTPS in production so clipboard and links work.

Run locally

npm install
npm run dev

Open http://localhost:3002. Run the API on port 3001 so Try it and the API Reference (OpenAPI) can load the spec from NEXT_PUBLIC_OPENAPI_URL (default http://localhost:3001/openapi.json) and send requests to NEXT_PUBLIC_API_URL (default http://localhost:3001).

Environment

Variable Description
NEXT_PUBLIC_OPENAPI_URL OpenAPI JSON URL (default http://localhost:3001/openapi.json)
NEXT_PUBLIC_API_URL API base URL for Try it (default http://localhost:3001)

Monorepo