How I Documented, Encrypted, and Tested My First REST API

• PHP Encryption

  3 3,732 5.6 PHP

  Simple Encryption in PHP.

I encrypted my data using defuse/php-encryption. This library, claiming to be secure, unlike other libraries, did the encryption and decryption for me. To encrypt and decrypt, I needed my own key, which I generated by running

• Borum-Dev-Documentation

  1 0 0.0 JavaScript

  Discontinued The developer documentation for the Borum Ecosystem

  

Here is a given page of my developer documentation website, which is live, hosted by Vercel, and open-source on GitHub:

• InfluxDB

  www.influxdata.com featured

  Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.

  

• PHPUnit

  47 19,578 9.9 PHP

  The PHP Unit Testing framework.

I used PHPUnit, a PHP unit-testing framework, and GuzzleHttp, a PHP HTTP client, to unit test my application. GuzzleHttp acts as a client to the REST API server, making requests and asserting information about the responses.

• Next.js

  2,049 121,024 10.0 JavaScript

  The React Framework

  

To document my APIs, I got inspiration from the Stack Exchange API documentation. I used NextJS to make a static documentation site for the entire Borum ecosystem, including Borum Jot. Then, for each page, I specified the request method, request headers, query string, request body (for POST, PUT, and DELETE requests), and response body.

Suggest a related project