Skip to content

Files

Latest commit

 

History

History
219 lines (151 loc) · 4.96 KB

APIDocumentation.md

File metadata and controls

219 lines (151 loc) · 4.96 KB

API Documentation - Web FPGA

Introduction

This documentation is here for the user to know how to use effeciently our API without opening the source code.

Our API as 4 endpoints which are listed below.

GET Methods

GET - Obtaining The Entire List Of Existing Applications

Static Badge

/api/list

Example:

http://localhost:3001/api/list

No parameters

Success 200

Field Type Description
status Number 200

Response (example)

[
    {
        "name": "FF1_exemples",
        "createdDate": "2025-03-24"
    },
    {
        "name": "test",
        "createdDate": "2025-03-25"
    }
]

Error 5xx

Code Name Description
500 Server Error Error listing directories.

GET - Obtaining A Single Result From The Server

Static Badge

/api/map/{projectName}

{}: parameters

Example:

http://localhost:3001/api/map/FF1_exemples

Parameter:

Field Type Description
projectName String name of the project to load.

Success 200

Field Type Description
status Number 200

Error 4xx

Code Name Description
400 Bad Request Project name is required.
404 Bad Request Project not found.

Response (example)

<!DOCTYPE html>
<html lang="en">

<head>
    <meta charset="utf-8">
    <title>Error</title>
</head>

<body>
    <pre>Cannot GET /api/map/</pre>
</body>

</html>

Error 5xx

Code Name Description
500 Server Error Error reading parsed SDF JSON file. File may not exist.

POST Methods

POST - Uploading An Existing File

Static Badge

/api/upload/

Example:

http://localhost:3001/api/upload/

body:
{
    ("sdfFile", file, "/path/to/file/FF1_norst_post_synthesis.sdf"),
    ("verilogFile", file, "/path/to/file/FF1_norst_post_synthesis.v"),
    ("projectName", text, "FF1_exemples")
}

Parameter (request body):

Field Type Description
sdfFile File SDF file.
verilogFile File Verilog file.
projectName text Project name.

Success 200

Field Type Description
status Number 200
message String Files uploaded successfully.

Error 4xx

Code Name Description
400 Bad Request Both SDF and Verilog files must be uploaded.
400 Bad Request One or both uploaded files are empty.
400 Bad Request Project name is required.
400 Bad Request The project already exists.
400 Bad Request Invalid file(s) format.
404 Bad Request File not found.

Error 5xx

Code Name Description
500 Server Error Error parsing SDF file.
500 Server Error Error parsing Verilog file.
500 Server Error Error merging files.
500 Server Error Error saving parsed JSON files.
500 Server Error Unexpected server error.

DELETE Methods

DELETE - Removing An Existing Application

Static Badge

/api/delete-project/{projectName}

{}: parameters

Example:

http://localhost:3001/api/delete-project/FF1_exemples

Parameter:

Field Type Description
projectName String name of the file to load.

Success 200

Field Type Description
status Number 200
message String Project deleted successfully.

Error 4xx

Code Name Description
404 Bad Request Project does not exist.

Error 5xx

Code Name Description
500 Server Error Error deleting directory, it may not exist.