SLIM CREATE REST API DOCUMENTATION HOW TO
SLIM CREATE REST API DOCUMENTATION CODE
SLIM CREATE REST API DOCUMENTATION MAC

You can useĪny programming language to generate the messages and the JSON or XML documents that contain the API methods or Managed Object Or HTTPS messages that contain JavaScript Object Notation (JSON) or Extensible Markup Language (XML) documents. The API accepts and returns HTTP (not enabled by default) The Application Policy Infrastructure Controller ( APIC) REST API is a programmatic interface that uses REST architecture.

Using the Managed Object Browser (Visore).

Requiring a Challenge Token for an API Session.

Authenticating and Maintaining an API Session.

Configuring a Custom Certificate for Cisco ACI HTTPS Access Using the GUI.

Configuring HTTP and HTTPS Using the GUI.

Configuring the HTTP Request Method and Content Type.

SLIM CREATE REST API DOCUMENTATION MAC

Example: XML Get Endpoints (Devices) with IP and MAC Addresses.

Example: Using the XML API and OwnerTag to Add Audit Log Information to Actions.

Example: Using the JSON API to Get Top Level System Elements.Example: Using the JSON API to Get Running Firmware.Example: Using the JSON API to Get Information About a Node.Example: Using the JSON API to Add a Leaf Port Selector Profile.Composing the API Command Body for an API Operation on an MO.Composing the API Command Body to Call a Method.Using Managed Objects in REST API Commands.Notice that, I add “./” in front of the vendor path because my files structure sets this way.

SLIM CREATE REST API DOCUMENTATION CODE

The code can be found at the Slim home page.

To do that, in the index.php, add the code below. Those folders and files are installed by the composer.Īfter installing the Slim, we want to test that Slim is working on our web server or not.

Now under the slimapi folder, you will see the new vendor folder, composer.json, and composer.lock.

Installing slim/slim (3.12.1): Loading from cache Installing pimple/pimple (v3.2.3): Loading from cache Installing psr/http-message (1.0.1): Loading from cache Installing nikic/fast-route (v1.3.0): Loading from cache Installing container-interop/container-interop (1.2.0): Loading from cache Installing psr/container (1.0.0): Loading from cache Package operations: 6 installs, 0 updates, 0 removals Updating dependencies (including require-dev) Loading composer repositories with package information You will see a similar message below in the terminal.

After the composer installs successfully.

Open the bash terminal(you can use your preferred terminal) and run the composer command.

Open the VScode(text editor tool) and open the slimapi folder.

At the webroot which is www folder in Wamp server, I create the new folder called “ slimapi“.

I will focus on creating an API in the Slim framework only. I am not gonna talk about the UnitTest in this post. The framework based on PHP and you can add the UnitTest(using PHPUnit) to work with the API as well.

SLIM CREATE REST API DOCUMENTATION HOW TO

In this post, I gonna share how to create the REST API with the fast and lightweight framework called Slim. So you can provide this special API for this Europe tour company only.Īs I am a web developer, I mostly work with Web APIs or often called RESTful (representational state transfer). For example, you agree to sell Thailand package tours with a spacial price for the Europe tour company. The partner API, it is used by the specific parties who make an agreement with. The public API, it is published outside the company such as the tour packages information. Mostly it is used for the development purpose for developers. In short, the private API is used as the internal API in the company. They are the private API, public API, and partner API. For example, you have your own custom application or custom website and you want to exchange your data with the Facebook app or mobile application or other applications, you can create your own API and allow those platforms to access your data that you want them to access.įor the business standpoint, API can open up new opportunities for new business partnerships with related service providers such as Travel business, Spa, Tour, Hotel and restaurant.ĪPIs can categorize in three basic types. It lets your product or service communicate with other platforms. API stands for an application programming interface. API, you may hear about it often nowadays.

Slim create rest api documentation