Skip to content

Create a new template specifically for API projects #8

@LukasPol

Description

@LukasPol

Developing APIs often requires a different set of configurations compared to traditional web applications.
This issue focuses on creating a new template tailored specifically for API projects, incorporating best practices and necessary components for building robust APIs in Rails.

Tasks:

  • Define the directory structure suitable for API projects.
  • Configure Rails API-only mode for minimal middleware.
  • Include tools like Jbuilder or Active Model Serializers for JSON serialization.
  • Implement token-based authentication using Devise or a suitable alternative.
  • Set up API versioning for better control over API changes.
  • Integrate Swagger or a similar tool for API documentation.
  • Configure CORS to handle cross-origin requests appropriately.
  • Implement and configure an authentication mechanism for API endpoints.
  • Provide documentation on using the API template for API development.

ChatGPT help me write this issue

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions