search

marcinadd / projecty-web

Project management software based on spring
GNU General Public License v3.0
76 stars 76 forks source link

Giving out some sample API requests to test/understand the current working of the project. #70

Open himanshugoyal1065 opened 4 years ago

himanshugoyal1065 commented 4 years ago

Hi, I was able to set up the projecty server but I'm still not sure about the complete functionality of the app and what are the different use cases and what are the endpoints I should hit along with what data I should pass.

I suggest adding some API requests as a sample inside the read.me file to explain the feature along with the request and response expected for that feature.

I know one can achieve this by looking at the files and doing some hit and trial, but why not make life easier? :)

FlorianKrammel commented 4 years ago

Hi,

I'm interested in this project, too. I'd suggest to use OpenAPI spec. This could be done with springdoc-openapi-ui. It'll autogenerate the identified API, allows custom documentation via annotations and integrate the openapi ui in the application. Checkout the attached JSON file at editor.swagger.io. Copy&Paste the content and skip the YAML conversion. I modified the UserController with tags, description etc. and added an example value and description to the user model. The rest is autogenerated and hopefully working request examples.

If it's desired I could create follow-ups to this issue and work on this.

projecty-web-openapi.json.gz

himanshugoyal1065 commented 4 years ago

I will have to learn a little more about it to be very clear about it. But, reading the json looks really promising.

Still, I need some more time.

The main point is, which can be common to all the projects, is that how a new contributor comes and knows like a grey box input output of the software.

Can you provide me some documents or youtube videos were I can read a little more about it?

FlorianKrammel commented 4 years ago

Try the json in the swagger UI. It's the perfect place for new contributors. If you start the application and adapt host, port and the sample data (my UserController sample should work) you should be able to execute requests in the UI and see the response. If you integrate it in the project, the swagger-ui will be available via spring.

Here is a short intro and documentation for further reading: https://www.baeldung.com/spring-rest-openapi-documentation

nagarajan-ck commented 2 years ago

Looks interesting, shall I work on this?

leena31 commented 1 year ago

Hi, Is this issue still open? If yes, i would like to integrate with swagger-ui

Deepinder04 commented 1 month ago

Hi, Is this issue still open? If yes, can I work on it using OpenAPI 3.0?