maciejowski2006 / sapi

Simple API server written in C#

SAPI - Simple API

SAPI is a library for creating APIs with C#. It's simple by design and allows for a lot of flexibility.

Installation

Add as dependency in NuGet

Install-Package SAPI -ProjectName <project>

In your preferred IDE:

By downloading and referencing the DLL (and its dependencies) in your project.

Usage

For detailed explanation You can also see docs

// Program.cs
using SAPI;
using SAPI.Endpoints;
using Project.Endpoints;

public static void Main(string[] args)
{
    // Init SAPI
    Server sapi = new();
    sapi.Start();
}

// Endpoints/Ping.cs
using System.Net;
using SAPI;

namespace Project.Endpoints
{
    public class Ping : Endpoint
    {
        public override string url { get; } = "ping";

        private override void Get(ref Packet packet)
        {
            Console.WriteLine("Ping!");
            
            Error.Page(HttpStatus.EnhanceYourCalm, ref packet);
        }
    }
}

sapi's Issues

Cannot refresh browser tab while on page with large file

Describe the bug
You cannot refresh the page when you enter the endpoint with file download. The bug is only present with large files.

To Reproduce
Steps to reproduce the behavior:

1. Create an endpoint that is holding a file
2. Add a large file(> 500MB) to the specified directory
3. Try refreshing a page

Expected behavior
The page should refresh.

Exceptions in endpoints should result in an HTTP response status 500 Internal Server Error

Currently, when an endpoint method throws an exception, a request doesn't finish, and times out. Such thing should be caught and result in a 500 Internal Server Error.

Example code that throws an exception:

using SAPI;

namespace ConsoleApp12.Endpoints;

public class GetServers : Endpoint
{
    public override string url { get; } = "get-servers";

    protected override void Get(ref Packet packet)
    {
        int.Parse("hello");
    }
}

Cannot dowload large files

Describe the bug
Cannot download large files. The server throws 500.

To Reproduce
Steps to reproduce the behavior:

1. Create an endpoint that is holding a file
2. Add a large file(> 500MB) to the specified directory
3. Open DevTools and navigate to the URL

Expected behavior
You should be able to download the file(and not get the HttpStatus 500)

(ref) Packet struct is breaking responses

ref Packet is breaking the logic of responses. You cannot attach new headers, nor add new cookies - the changes you make are not reflected on the HttpListenerResponse.

Server always starts at default URL (http://localhost:8000)

The server always starts at the default URL, even though it says it runs on the one specified in a config file.

Crash when file directory does not exist

Describe the bug
Server crashes when trying to host file on a directory that does not exist.

To Reproduce
Steps to reproduce the behavior:

1. Create an endpoint that is holding a file/directory, and point it to a non-existent directory
2. Try opening a page

Expected behavior
The server should not crash

HEAD request results in a server error

What happens?

HTTP HEAD requests results in a server error

Expected behavior

Response to a HEAD request should include the same headers as in a GET request for same the URL, but without a body.

Screenshots

Undefined methods result in HTTP code 200

When sending an HTTP request with a method that wasn't defined on an endpoint, SAPI responds with HTTP code 200 and empty body (except POST, which returns 400 Bad Request), instead of 405 Method Not Allowed.

---

using ConsoleApp12.Services;
using SAPI;
using SAPI.API.Utilities;

namespace ConsoleApp12.Endpoints;

public class GetServers : Endpoint
{
    public override string url { get; } = "get-servers";

    protected override void Get(ref Packet packet)
    {
        var servers = Database.GetServers();
        Json.Response(servers, ref packet);
    }
}

Timeout on requests for undefined endpoints

Requests for undefined endpoints result in a timeout / unfinished request, instead of a 404 error.

kiedy

kiedy zrobisz jakoms gre #55