Skip to content

maxsrli/Encrypter-API

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

API Testing Codacy Badge CodeQL GitHub

Description

A REST API of Python script Encrypter.

This API is written using Python web framework Flask with Flask-RESTful.

API URL: https://encrypter-api.onrender.com

Usage

Route 1

Request:

  • Route: /
  • Route: /ping
  • Method: GET

Response:

  • Response body (JSON):
{
  "status": "ok"
}
  • Response status code: 200

Route 2

Request:

Response:

  • Response body (JSON):
{
  "encrypter": "3.3",
  "api": "1.4"
}
  • Response status code: 200

Route 3

Request:

  • Route: /encrypt
  • Method: POST
  • Query Parameter:
Field Type Description
input String The input to be encrypted

Successful Response:

  • Response body (JSON):
{
  "result": "<encrypted_text>"
}
  • Response status code: 200

Error Response:

  • Response body (JSON):
{
  "error": "<error_message>"
}
  • Response status code: 400

Route 4

Request:

  • Route: /decrypt
  • Method: POST
  • Query Parameter:
Field Type Description
input String The input to be decrypted

Successful Response:

  • Response body (JSON):
{
  "result": "<decrypted_text>"
}
  • Response status code: 200

Error Response:

  • Response body (JSON):
{
  "error": "<error_message>"
}
  • Response status code: 400