Projects
Readme.md•View on GitHub
Simpl:api is a simple API builder with GUI Dashboard
🧱 Tech Stack
License
This is an open-sourced software licensed under the MIT license.
Readme.md•View on GitHub
a REST API and UI for SQL Server Agent Jobs with Express and React
Installation
1. API Server Installation
- Change directory to webapi folder and install packages with
npm installcommand. - Change name of
.env.examplefile to.envand edit .env file to set api server port, database and web ui information. - Start server with "npm start" (for development mode "npm run dev").
- If everything is correct, on console, you will get messages as follows:
Server is running on Port:[PORT_NUMBER] DB Connection Successfull!
5.If you get these messages, you can try on your browser to connect the API server with available api server routes.
2. WebUI Installation
- Change directory to webui folder and install packages with
npm installoryarn installcommand. - By default logo is react's own logo, if you want to change it, you replace
logo192.pngfile in /webui/public directory. - By default, port is 3001, if you want change this, in Windows
SET PORT=[PORT_NUMBER]and in linux "exportPORT=[PORT_NUMBER]command will change port number. But if you change the port, you have build the application again for production mode withnpm buildoryarn buildcommand. - Start server with
serve -s build(or for development modenpm startoryarn start) command
API Server Routes
| Route | Description |
|---|---|
| /api/jobs | returns all jobs from sysjob table |
| /api/jobs/details | returns all jobs with their activity, history, steps, servers, schedules data |
| /api/job/:id | returns only job data from sysjob table by job_id ( :id part of url should be replaced with job_id ) |
| /api/job/:id/details | returns selected job by job_id and its activity, history, steps, servers, schedules data |
| /api/job/name/:name | returns only job data from sysjob table by name (job name) |
| /api/job/name/:name/details | returns both job data from sysjob table by name (job name) and its activity, history, steps, servers, schedules data |
| /api/steps | returns all steps data from sysjobsteps table |
| /api/activity | returns all activity data from sysjobactivity table |
| /api/schedules | returns all schedule data from sysjobschedules table |
| /api/schedules/details | returns all schedule data with related job data(by job_id) from sysjobschedules and sysjob table |
| /api/history | returns all history data from sysjobhistory table |
| /api/servers | returns all server data from sysjobservers table |
| /api/servers/details | returns server data by server_id and jobs that are run in that server |
| /api/server/:id | returns only server data from sysjobserver table by server_id |
| /api/server/:id/details | returns server data by server_id and both jobs that are run on that server and details of the jobs |
| /api/server/name/:name | returns server data by originating_server |
| /api/server/name/:name/details | returns server data by originating_server and both jobs that are run on that server and details of the jobs |
License
This is an open-sourced software licensed under the MIT license.
Dependencies
WebUI
- React
- react-bootstrap
- react-router
- react-icons
- bootswatch
- FullCalender
- nivo
- Moment.js
- react-moment
- css-loaders