search

section-engineering-education / engineering-education

“Section's Engineering Education (EngEd) Program is dedicated to offering a unique quality community experience for computer science university students."
Apache License 2.0
363 stars 889 forks source link

Build A RESTful API With AdonisJS #1218

Closed Kaperskyguru closed 3 years ago

Kaperskyguru commented 3 years ago

Brief Summary:

Describe the what, why, and how of your content idea in 2-5 sentences.

I will be showing you how to build a RESTful API with AdonisJS 5. I will build an API for a forum. I am going to look at things like authentication, pagination, filtering, and sorting. I will also cover best practices in structuring and building out your HTTPS endpoint and also industry standard responses.

AdonisJS is the Laravel of JavaScript and a good grasp of it is a high-demand skill, therefore learning a build your first REST API with it is a game-changer.

Key Takeaways:

What are the 3-5 most important things the reader should understand or be able to do after reading this article?

  1. Students will learn how to build REST APIs with AdonisJS
  2. Students will learn how to handle authentication with AdonisJS
  3. Students will learn important concepts such as Pagination, Filtering, and Sorting, etc.
  4. Student will learn how to build and structure a Forum API and Database Schemas
  5. Students will learn best practices in building performance-oriented APIs.

References:

Please list links to any published content/research that you intend to use to support/guide this article. (If none, please indicate 'N/A'.) https://adonismastery.com/courses/build-a-restful-api-with-adonisjs https://codeburst.io/build-rest-api-with-adonisjs-based-on-tdd-and-migration-management-e3f21469f763 https://www.techiediaries.com/adonis-tutorial-rest-api/

ninjaginja commented 3 years ago

great topic @Kaperskyguru - approved.

Just one side note: I noticed that you mention 'students' as the primary audience in your key takeaways. Our readership expands far beyond students to a very broad developer/engineering community :) Just wanted to note it so you avoid addressing students specifically.

Kaperskyguru commented 3 years ago

That's my fault, Should be "Readers".

Thanks for the update and approval.

Kaperskyguru commented 3 years ago

Hello

I just want to inform you that I have started building out the API and write the content, I will send my first draft across before the end of next week.

Thanks.

hectorkambow commented 3 years ago

Good morning Solomon,

That is great thank you - if the article is in draft form - lets keep that work in your forked repo and only create a PR once the article is ready.

On Sat, 23 Jan 2021 at 05:37, Solomon Eseme notifications@github.com wrote:

Hello

I just want to inform you that I have started building out the API and write the content, I just send my first draft across before the end of next week.

Thanks.

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/section-io/engineering-education/issues/1218#issuecomment-765963368, or unsubscribe https://github.com/notifications/unsubscribe-auth/AOP32ZRP35AYC7P7YAM3PZLS3K7ITANCNFSM4VZXLKDQ .

-- Hector Kambow​ Email: hector@section.io Phone: Web: www.section.io [image: Section] https://www.section.io/ [image: Follow on Twitter] https://twitter.com/sectionio [image: Connect on LinkedIn] https://www.linkedin.com/company/section_io/ [image: Star on Github] https://github.com/section-io/ [image: Talk to a Developer] https://slack.section.io/

Kaperskyguru commented 3 years ago

Hello @hectorkambow,

I just finished my first draft of this article.

Here is the editable link to my dropbox:

https://www.dropbox.com/scl/fi/bqi2cx4mj05n659vsrxhx/Build-A-RESTful-API-With-AdonisJS.paper?dl=0&rlkey=i66o4hw3b82fx4ya2dihyb5zy

Let me know if there is anything as you review.

Thanks.

Kaperskyguru commented 3 years ago

Hello @hectorkambow,

I just finished my first draft of this article.

Here is the editable link to my dropbox:

https://www.dropbox.com/scl/fi/bqi2cx4mj05n659vsrxhx/Build-A-RESTful-API-With-AdonisJS.paper?dl=0&rlkey=i66o4hw3b82fx4ya2dihyb5zy

Let me know if there is anything as you review.

Thanks.

hectorkambow commented 3 years ago

👋 @Kaperskyguru
Fantastic - upon initial glance, the article looks nice.

I'd suggest checking out our resources page for any last min tips on how to polish up the article before submission.

Unfortunately due to our limited staff - we do not have the capacity to provide revisions services at this time.

We have added some vetted (and affordable) options for basic revisions service on our resources as well.

Whenever you think the article is ready to be reviewed for technical accuracy - here are some step by step docs.

Thank you 🚀