Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Simple API Endpoint Example #22

Open
Laxmi2707 opened this issue Feb 1, 2025 · 1 comment
Open

Create a Simple API Endpoint Example #22

Laxmi2707 opened this issue Feb 1, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation Easy enhancement New feature or request good first issue Good for newcomers IWOC2025

Comments

@Laxmi2707
Copy link
Member

Description

The project lacks an example API endpoint to help new developers understand how Expressify works.

Steps to Implement

  1. Add a new route in routes/example.js.
  2. Create a simple GET endpoint that returns a JSON response.
  3. Update the documentation to explain the endpoint.

Expected Outcome

New contributors can easily understand how to add new API endpoints.

@Durgesh4993 Durgesh4993 added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers IWOC2025 Easy labels Feb 1, 2025
@ionesosa-e
Copy link

Hi! I'm interested in working on this issue as my first open-source contribution.
I noticed that the project is a CLI tool built with Bubble Tea and doesn’t currently have an HTTP server or API routes. Before proceeding, I’d like to clarify what is meant by “routes” in this context:

Should I implement an actual HTTP server in Go (e.g., using net/http) to handle an API route like GET /example?
Or does "routes" refer to adding a new feature in the CLI to help users generate route files when creating an Express.js project?
I want to make sure I align with the project's goals before starting. Looking forward to your guidance!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation Easy enhancement New feature or request good first issue Good for newcomers IWOC2025
Projects
None yet
Development

No branches or pull requests

3 participants