Welcome to the comprehensive documentation for the Blog API! This is a production-ready RESTful API designed for managing blog posts, users, comments, and engagement features.
Live API: https://blog-api-dc2g.onrender.com/api/v1
New to the API? Start here:
- Quick Start Guide - Get up and running in minutes
- Authentication - Understand the security model
- API Reference - Complete endpoint documentation
- Version: 1.0.0
- Authentication: JWT Bearer tokens with refresh token support
- Authorization: Role-based access control (admin/user)
- Rate Limiting: 60 requests per minute per IP address
- Content Format: JSON with multipart/form-data for file uploads
- Security: HTTPS, HTTP-only cookies, CORS enabled
- User registration and login
- JWT access tokens with automatic refresh
- Role-based permissions (admin/user)
- User profile management
- Social media links support
- Rich HTML content support
- Image banner uploads (Cloudinary integration)
- Draft and published status
- SEO-friendly URL slugs
- View tracking and analytics
- Comment system with moderation
- Like/unlike functionality
- Real-time engagement metrics
- User interaction tracking
- Rate limiting protection
- Input validation and sanitization
- Error handling with detailed responses
- Optimized for production deployment
- Overview - API introduction and navigation
- Quick Start - Get started in 5 minutes
- Authentication - JWT tokens and auth flows
- Users - User management endpoints
- Blogs - Blog post CRUD operations
- Comments - Comment system features
- Likes - Engagement and likes management
- Data Models - Complete schema definitions
- Error Responses - Error handling guide
- Rate Limiting - API usage limits and headers
- Error Handling - Common errors and solutions
- Frontend Applications: Build web or mobile blog readers
- Content Management: Create admin dashboards for blog management
- Integrations: Connect with existing systems and workflows
- Learning Projects: Practice API integration and authentication
- Blog Platforms: Power your own blogging platform
- Portfolio Sites: Showcase articles and writing
- Community Platforms: Enable user-generated content
- Educational Content: Manage courses and tutorials
- Runtime: Node.js with Express.js
- Database: MongoDB with Mongoose ODM
- Authentication: JWT with bcrypt password hashing
- File Storage: Cloudinary for image management
- Validation: express-validator for input validation
- Security: Helmet.js, CORS, rate limiting
- Hosting: Render.com deployment
- CDN: Cloudinary for image delivery
- Monitoring: Built-in logging and error tracking
- Documentation: GitBook integration
Check the API health status:
curl https://blog-api-dc2g.onrender.com/api/v1/Response:
{
"message": "API is live",
"status": "ok",
"version": "1.0.0",
"docs": "https://ashutosh-3.gitbook.io/blog-api/"
}- Live API - Production endpoint
- GitBook Documentation - Interactive docs
- GitHub Repository - Source code
- OpenAPI Specification - Machine-readable API spec
Need help or found an issue?
- 📖 Documentation: Check the relevant sections in this documentation
- 🐛 Bug Reports: Create an issue on GitHub
- 💡 Feature Requests: Suggest improvements via GitHub issues
- 📧 Contact: Reach out to the development team
This project is licensed under the Apache License 2.0. See the LICENSE file for details.
Ready to start building? Head over to the Quick Start Guide and create your first API integration in minutes!