17.0: API Documentation

17.0: API Documentation

  1. Make sure there are some notes in the database for your specific user. If not add some.

  2. We'll need some NoteId's to test with, take a look at the database and make note of a NoteId for the specific user as well as the next available Id#

  3. Run the API

  4. Add /help to the URL to see the API docs with the newly constructed endpoints that were auto-generated from the API Controller methods

  5. You can also get here by clicking on API in the header

    Endpoints

    It's important to learn how to use this documentation. If you were to have a more focused career in front-end development, you would need to be able to use these endpoints as an access point into your application database. If you are a back-end developer, you will need to read these endpoints to test your API before it's live to all. Notice that the documentation matches the parameters of your APIController methods.

Next, we'll test the GetNoteById method.

Last updated