filebrowser-docker icon indicating copy to clipboard operation
filebrowser-docker copied to clipboard

Provide API Documentation And some sdk client and server for filebrowser inside Docker container

Open ambroisehdn opened this issue 1 year ago • 1 comments

Description:

I need assistance in creating comprehensive API documentation and developing software development kits (SDKs) for both client and server sides to integrate FileBrowser within a Docker container. The goal is to streamline file storage and management within a Docker environment, ensuring seamless integration and ease of use for developers.

Tasks to be Completed:

1. API Documentation:

  • Create detailed documentation outlining all endpoints, request formats, and response structures for the FileBrowser API.
  • Include examples and use cases to guide developers in utilizing the API effectively.

2. Client SDK:

  • Develop an SDK for interacting with FileBrowser from client applications.
  • Include functions/methods for file upload, download, deletion, and metadata retrieval.
  • Ensure compatibility with popular programming languages and frameworks.

3. Server SDK:

  • Build a server-side SDK to facilitate integration of FileBrowser functionalities within Docker containers.
  • Include modules for user authentication, access control, and file system operations.
  • Provide clear instructions on integrating the SDK with Dockerized applications.

Expected Deliverables:

  • Well-documented API with examples.
  • Client SDK for various programming languages.
  • Server SDK for Docker container integration.
  • Instructions or guidelines for using the SDKs effectively.

Additional Information:

  • The target environment is Docker, so the SDKs should be Docker-friendly.
  • Compatibility with common programming languages (Python, JavaScript, Java, etc.) is preferred for wider adoption.
  • Any best practices or recommendations for secure file handling within Docker containers would be appreciated.

ambroisehdn avatar May 12 '24 09:05 ambroisehdn

Im creating an API to golang at the moment, is a simple package than allows you to log in and upload files, i will create new features with the time, hope it helps you :) will be also soon in npm with ts.

dockerdavid avatar Oct 04 '24 03:10 dockerdavid