Find Jobs
Hire Freelancers

Automate documentation generation for Swagger

$30-250 USD

Zavřený
Zveřejněno před více než 2 roky

$30-250 USD

Zaplaceno při doručení
We have inline documentation in our project, in the source code itself, here is an example: /* * @api [get] /todo/{id} * description: "Get a todo" * parameters: * - (path) todo_id= {Int} * responses: * "200": * description: todo object */ const authGet = async function (req: Request, res: Response, next: NextFunction) { const id = parseInt([login to view URL]); if (isNaN(id)) { send_failure(400, res, { reason: 'invalid todo_id' }); return; } ... } We are using a tool called swagger-inline for nodejs which generates this documentation: [login to view URL] We are not really happy about this, as the documentation isn't properly generated. It also doesnt look pretty. From you we need: 1. Standardise our documentation generation from inline code 2. Create a method for us to use when publishing our code for production which automatically generates our API documentation (CI) 3. Make our documentation look more pretty and professional 4. Give us guidelines on how to properly document all our endpoints for POST, GET, PUT, DELETE 5. Help us migrate all our existing documentation and in the end have a nice API documentation 6. Show us examples of how it may look before you proceed to work All our code is written in TypeScript and we are using Node.js as backend, npm (or yarn).
IČ projektu: 32887902

O projektu

6 nabídky
Vzdálený projekt
Aktivní před 2 roky

Chcete si vydělat nějaké peníze?

Výhody podávání nabídek na Freelancer

Stanovte si rozpočet a časový rámec
Získejte za svou práci zaplaceno
Načrtněte svůj návrh
Registrace a podávání nabídek je zdarma
6 freelanceři nabízejí v průměru $135 USD za tuto práci
Avatar uživatele
Hello. How are you? I hope you are well and I can provide the best documentation of our project. I have 6+years experience with backend development. And I will manage all feedback without any payment. Please message me. Thanks. Regards.
$140 USD v 7 dnech
5,0 (1 recenze)
2,9
2,9
Avatar uživatele
Hi! This is a part of my last work's swagger.json. ex: "paths": { "/candidate":{ "post":{ "summary": "This route is used to create a candidate.", "tags": ["Candidates"], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#components/schemas/Candidate" }, "example":{ "candidate": { "value": { "firstname": "Jane", "lastmane": "Doe", "username": "janedoe", "password": "1234" } } } } } }, "responses":{ "200":{ "description": "Candidate created." }, "400":{ "description": "Error to created." } } } }
$150 USD v 7 dnech
5,0 (2 recenze)
2,7
2,7
Avatar uživatele
Hi, I see that you need some assistant in Automate documentation generation for Swagger I have skills in: C,C#,C++,JAVA and I have experience in web development. I have skills with the following programming languages: C, "C ++", "C #", Python, GO, Matlab, Java, VB, kotlin, JavaScript. Web development skills: Full-stack, Front-End, Back-End, Responsive Design. - Angular, React, Jquery, Ajax - Bootstrap, CSS3, Less, Sass, Scss, Responsive, Material. - JSON, XML. Skills with the following web languages: - PHP, NET CORE, Aspx, HTML5, JSP, RUBY. I would be glad if the opportunity of doing this task can be given to me. i'll await your message to have more discussion with you on the project. Kindly check my profile https://www.freelancer.com/u/mzdesmag to see my past works and reviews. Thanks.
$130 USD v 3 dnech
5,0 (1 recenze)
2,2
2,2
Avatar uživatele
Hi there, My name is Umair. I have good experience with Node.js. I am a practicing Developer/Designer Since 2015. I can perfectly work on this project regarding Node.js. Based on my experience, I can do this task for you and the quality of work would be up to the mark. However, further discussions are required for more clarity. I will wait for your text to discuss the project in further detail. Thanks & Regards Umair A.
$150 USD v 10 dnech
0,0 (0 recenze)
0,0
0,0

O klientovi

Pochází z SWEDEN
Stockholm, Sweden
5,0
5
Ověřená platební metoda
Členem od kvě 27, 2019

Ověření klienta

Díky! Poslali jsme vám e-mailem odkaz pro získání kreditu zdarma.
Při odesílání e-mailu se něco pokazilo. Zkuste to prosím znovu.
Registrovaných uživatelů Zveřejněných projektů
Freelancer ® is a registered Trademark of Freelancer Technology Pty Limited (ACN 142 189 759)
Copyright © 2024 Freelancer Technology Pty Limited (ACN 142 189 759)
Načítání náhledu
Bylo uděleno povolení ke geolokaci.
Vaše doba přihlášení vypršela a byli jste odhlášeni. Přihlaste se znovu.