Elentra API
  • Introduction
  • Developers
    • Getting Started
    • Quickstart Guide
      • Set up Repositories
      • Validate the setup
      • Exploring the API
      • Creating a new Module
      • Setup Routing
      • Introduction to Postman
      • Create a Controller
      • Using Eloquent Models
      • Input Validation
      • API Resource Authorization
  • Elentra API Standards
    • HTTP Methods & Status Codes
    • Routing & Parameters
      • Example Routing Patterns with HTTP Method
        • /courses/{course}/contacts
        • /courses/{course}/contacts?type={contact_type}
        • /courses/{course}/contacts/{contact}
        • /courses/{course}/syllabus
      • Common Mistakes
        • [GET] /admissions/file-review/file/rubric-score/{cycle_id}/{pool_id}/{subpool_id}
        • [DELETE] /notices/1,2,3
        • [GET] /cbe/curriculum/framework/{framework_id}/hierarchy-by-depth
        • [GET] /admissions/file-review/file/rubric-score/delete/{id}
        • [GET] /portfolio/entries/{entry_id}/get-file
        • [POST] /cbe/curriculum/updateframework
  • Automated Testing
    • Getting Started
      • Setting up a testing environment
      • Running Automated Tests
    • Seed Data
      • Folder Structure
      • Creating Seed Data
    • Functional Tests
      • Creating a Functional Test File
      • Testing HTTP Verbs
        • Creating an HTTP Test
        • GET Requests
        • POST / PUT / DELETE Requests
        • GraphQL Requests
      • Asserting API Response
      • Annotations
    • Code Style Linting
Powered by GitBook
On this page
  1. Developers
  2. Quickstart Guide

Validate the setup

PreviousSet up RepositoriesNextExploring the API

Last updated 2 years ago

Once you have your repositories set up and linked for development, you are ready to make changes in the API. Lets make a tiny change to ensure that it is working properly.

In a browser, navigate to the top level route of the API (). If you have Elentra ME installed with a different virtual host, adjust the URL to match. This should give a response something like this:

If you do not see the link above, make sure that there were no errors in the composer setup under Set up Repositories. Also check that you can run the Elentra ME application without errors.

Now lets make a change to the message that is produced by the default route. Open PHPStorm, navigate to the elentra-1x-api directory and open the directory routes/api. Edit the file api.php and you will see the message that was produced on the browser.

Change the message in some way. For example add 'Hello, World.' to the beginning of the message. Then go back to the browser and refresh the default route. You should see the changed message.

If you do not see the updated message, make sure PHPStorm is open on the right repository and that the repository that is checked out is the same as composer-api-dev.json

Reset the changes to routes/api/api.php.

You have now validated that your API and ME repositories are linked and ready for development.

http://elentra-1x-me.localhost/api/v2
Testing the default API route
The default route of the API
Updated default API route