Strux api

Документація українською.

Other sections

• The structure of microservices
• More about the user microservice
• Learn more about package microservice

About the project

Strux api is a project designed for package management (also requires server client). A package is just a directory with a user project. Everything in the same directory can be considered a package if properly prepared. For other users to download packages, they need to be moved to the server using a client. To create a package, you need to use the server client.

Getting started

To get started, follow the instructions below.

If this project is used as a server, the repository must be downloaded from this link:

https://github.com/uwine4850/strux_api

To start the server, you need to start the server. First, you need to start the microservices (main.go) in the services directory:

• Microservice for users
• Package microservice

After that, you need to start the http server located at cmd/main.go.

If this project is used as an additional package, you need to install it using the command:

go get github.com/uwine4850/strux_api

Information about the api

The service contains the following commands:

• http://host/create-user/ - user creation. [Info]
• http://host/user-exist/ - checking the availability of the user. [Info]
• http://host/user-delete/ - deleting a user. [Info]
• http://host/user-password-update/ - password update. [Info]
• http://host/user-log-in/ - user login to the system. [Info]
• http://host/upload-pkg/ - uploading the package to the server. [Info]
• http://host/exists-package/ - checking the availability of the package. [Info]
• http://host/download-package/ - downloading a package from the server. [Info]
• http://host/package-versions/ - returns all available versions of the package. [Info]

Briefly about the work algorithm

To execute the command, you need to send a form to one of the http addresses. For example, to send a form using golang you can use http.NewRequest. The server accepts only data in the form of a form, the fields can contain text or file data. After processing the form, the server returns either text data (text/plain) or a form (multipart/form-data). To use the api, it is better to use a client, but it is not required.