Skip to content

Latest commit

 

History

History
183 lines (132 loc) · 4.57 KB

docs.md

File metadata and controls

183 lines (132 loc) · 4.57 KB
Raw

April 1.0.0

About

This language was made for making API's great ease and more efficiency.

The language connects each API endpoint to a specific program/command, in case you want to write the code for the endpoint '/home' in python and '/generate' in Cpp - this can be done.

The language have packages for multiple languages for adapting april to the wanted language (some packages are made by the community too!!) . In case you dont find the required package for utilizing april in your wanted language - don't worry its easy to make a package for your own.

Note

  • You need python3, redis server and pip3 installed on your system
  • You can install april via pip
  • The file extention for april is .apl

Features

  • Easy install
  • Simple
  • Efficient
  • Inbuild ratelimiting features (if req)
  • Auto-Generated API Docs (if req)
  • Banned IPs
  • Disallow Private IPs (if req)
  • Cross platform

Installation

WIndows :

pip install aprillang

Linux / MacOs:

pip3 install aprillang

Commandline examples

Get the list of allowed commands

april -h

Get info of the language

april -a

Compile an .apl file (april file):

  • This converts the april code to python3 code
  • Compiled file is saved as filename without extention apl + '_apl.py'
april -c file.apl

Run an .apl file (start the API server):

  • Format for the command is - april -r host:port
april -r file.apl 0.0.0.0:8080

Get the version of april:

april -v

Code examples

Keyword commands

  • Generate Documentation ( 'GEN_DOC {eg : /e/e/doc }' )

  • Rate Limiting ( 'RATE_LIMIT {how many per min}' )

  • Disallow Private IP ( 'DISALLOW_PRIVATE_IP' )

  • Not Allowed IP ( 'NOT_ALLOWED_IP {textfile.txt each ip sep by \n}' )

  • Import april files ( 'IMPORT {filename}' )

  • Other keywords:

    • TITLE '{}'
    • VERSION {}
    • DESC '{}'

General Commands

  • General format :

<request_type eg: get,post..>(<the api endpoint, use '{var-name}' when there is a variable in the endpoint url eg: '/home/page/{}') :

example: Making a Get endpoint:

get('/home') : python3 home.py

Making a Get endpoint with 1/more variables:

get('/home/page/{x}/para/{y}') : python3 home.py

Then the rest is done with the help of packages made for integrating april with them. You can find the list of packages in the home page .

Properties

These are attributes which can be added to general commands

Uses '--'

  • --L = {call-per-min} (set limiting for a single endpoint)
  • --N = {Name for the end point} (to put in docs)
  • --D = {Desc for the end point} (to put in docs)

Commenting

  • This can be done by using '//'
  • There is only single line commenting

Examples:

// Program 1

IMPORT X // importing x

Importing

  • You can import other april files into an april program
  • Importing an other apl code would ignore the keyword commands from the imported file
  • Importing can be used to apply the same endpoints in your apl file
  • You just need to mention the file name without extention
  • The file should be saved with an .apl extention

Example :

IMPORT code // the imported code should be saved as code.apl

About making a package yourself

  • The packages are used to connect the april program and the program dedicated to the endpoint.
  • When the program pointed to the endpoint is called the program is suplied with a call ID in the form of commandline argument (last argument). The program can access details related to the request in the json file "." + call ID + ".input". And the output of the program can be put in to the json file "." + call ID + ".output".

About the input and output files

Input File :

  • Json file
  • Filename : "." + call ID + ".input"
  • Contains information about the request , 
    {
"request" : dict containing info of the request,
"input" : {"varible_name_in_the_url" : "value", ....}
}

Output File :

  • Json file
  • Filename : "." + call ID + ".output"
  • Should contain information about the response ,
{
"headers" : <headers for the response>,
"status" : <status code>,
"output" : "the data to be send out to the user"
}
  • The output and input files automatically gets deleted when the data in the output file is gained.

Support

For support, join our discord server https://discord.gg/PXMSPJXhXd.

License

MIT