The API documented herein is for the latest version of the NanoDLP 3D printing control system. As a system under active internal development, the specifications detailed in this Swagger/OpenAPI documentation are fluid and subject to revision at any time.
swagger.json- Complete OpenAPI 2.0 specification in JSON formatswagger.yaml- OpenAPI 2.0 specification in YAML format
The documentation covers 231+ API endpoints across all modules:
- Web API - Core printer control and management
- Editor - 3D model editing and manipulation
- Debug - Development and debugging utilities
- Task Management - Background job processing
- Go to https://editor.swagger.io/
- Click "File" → "Import File"
- Upload
swagger.jsonorswagger.yaml - Explore the interactive API documentation
# Install swag tool
go install github.com/swaggo/swag/cmd/swag@latest
# Serve documentation locally
swag serve -F swagger swagger.jsonThen open http://localhost:8080/swagger/index.html
# Install redoc-cli
npm install -g redoc-cli
# Generate and serve Redoc documentation
redoc-cli serve swagger.jsonThen open http://localhost:8080
- Install "OpenAPI (Swagger) Editor" extension
- Open
swagger.jsonorswagger.yaml - Use the built-in preview feature
- Total Endpoints: 231+
- Authentication: Bearer Token
- Base URL:
http://localhost:8080 - Protocols: HTTP, HTTPS
- Response Formats: JSON, HTML, Binary
- Authentication - User login and security
- Plates - Print job management
- Slicing - 3D model processing
- Editor - Model manipulation tools
- Printer - Hardware control
- Debug - Development utilities
Q: Documentation shows only a few endpoints
A: Ensure all route files have proper @Summary annotations and run the generation script with all flags.
Q: Swagger UI shows errors A: Check that the JSON/YAML files are valid. Use an online validator to verify.
Q: Missing type definitions
A: Replace custom types with map[string]interface{} or define proper response models.