14458 – Add SwaggerUI documentation for RESTful API

Bug 14458 - Add SwaggerUI documentation for RESTful API

Summary: Add SwaggerUI documentation for RESTful API

Status:	CLOSED WONTFIX

Alias:	None

Product:	Koha
Classification:	Unclassified
Component:	REST API (show other bugs)
Version:	Main
Hardware:	All All

Importance:	P5 - low enhancement
Assignee:	Bugs List
QA Contact:

URL:
Keywords:

Duplicates (1):	14455 (view as bug list)
Depends on:	13799
Blocks:	14461
	Show dependency tree / graph

Reported:	2015-06-25 06:57 UTC by Julian Maurice
Modified:	2018-12-03 20:04 UTC (History)
CC List:	3 users (show)

See Also:
Change sponsored?:	---
Patch complexity:	---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:
Circulation function:

Attachments
Bug 14458: Add SwaggerUI documentation for RESTful API (1.01 MB, patch) 2015-06-25 06:58 UTC, Julian Maurice	Details \| Diff \| Splinter Review
Bug 14458: Fix missing character encoding in SwaggerUI index.html (740 bytes, patch) 2015-06-25 06:58 UTC, Julian Maurice	Details \| Diff \| Splinter Review
Bug 14458: Add SwaggerUI documentation for RESTful API (5.48 MB, patch) 2015-07-24 14:09 UTC, Olli-Antti Kivilahti	Details \| Diff \| Splinter Review
Bug 14458: 5. Add SwaggerUI documentation for RESTful API (5.58 MB, patch) 2015-08-03 08:29 UTC, Olli-Antti Kivilahti	Details \| Diff \| Splinter Review
Bug 14458: 5. Add SwaggerUI documentation for RESTful API (5.58 MB, patch) 2015-08-04 07:58 UTC, Olli-Antti Kivilahti	Details \| Diff \| Splinter Review
Bug 14458: 5. Add SwaggerUI documentation for RESTful API (5.58 MB, patch) 2015-08-17 12:16 UTC, Olli-Antti Kivilahti	Details \| Diff \| Splinter Review
Bug 14458: (follow-up) Add checkbox to optionally disable Authorization-header (2.66 KB, patch) 2015-08-25 12:02 UTC, Lari Taskula	Details \| Diff \| Splinter Review
Bug 14458: 5. Add SwaggerUI documentation for RESTful API (5.58 MB, patch) 2015-09-03 14:12 UTC, Olli-Antti Kivilahti	Details \| Diff \| Splinter Review
Show Obsolete (5) View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.

Description Julian Maurice 2015-06-25 06:57:09 UTC

Comment 1 Julian Maurice 2015-06-25 06:58:46 UTC Comment hidden (obsolete)

Created attachment 40614 [details] [review]
Bug 14458: Add SwaggerUI documentation for RESTful API

Test plan:
1/ Go to http://api.HOSTNAME/v1/doc
2/ Try to play request for /borrowers and /borrowers/{borrowernumber}
paths

WARNING: /borrowers return all borrowers, so I recommend not to test it
if you have many borrowers in your database

Comment 2 Julian Maurice 2015-06-25 06:58:49 UTC

Created attachment 40615 [details] [review]
Bug 14458: Fix missing character encoding in SwaggerUI index.html

Comment 3 Olli-Antti Kivilahti 2015-07-23 07:01:20 UTC

*** Bug 14455 has been marked as a duplicate of this bug. ***

Comment 4 Olli-Antti Kivilahti 2015-07-24 14:09:26 UTC Comment hidden (obsolete)

Created attachment 41167 [details] [review]
Bug 14458: Add SwaggerUI documentation for RESTful API

Test plan:
1/ Go to http://api.HOSTNAME/v1/doc
2/ Try to play request for /borrowers and /borrowers/{borrowernumber}
paths

WARNING: /borrowers return all borrowers, so I recommend not to test it
if you have many borrowers in your database

Now with a working API KEY authentication system!

Comment 5 Olli-Antti Kivilahti 2015-08-03 08:29:04 UTC Comment hidden (obsolete)

Created attachment 41309 [details] [review]
Bug 14458: 5. Add SwaggerUI documentation for RESTful API

Comment 6 Olli-Antti Kivilahti 2015-08-04 07:58:00 UTC Comment hidden (obsolete)

Created attachment 41332 [details] [review]
Bug 14458: 5. Add SwaggerUI documentation for RESTful API

Comment 7 Olli-Antti Kivilahti 2015-08-17 12:16:43 UTC Comment hidden (obsolete)

Created attachment 41544 [details] [review]
Bug 14458: 5. Add SwaggerUI documentation for RESTful API

Comment 8 Lari Taskula 2015-08-25 12:02:09 UTC

Created attachment 41908 [details] [review]
Bug 14458: (follow-up) Add checkbox to optionally disable Authorization-header

In case you want to test in SwaggerUI without sending the Authorization-header,
there is now a checkbox to optionally disable it.

Comment 9 Olli-Antti Kivilahti 2015-09-03 14:12:11 UTC

Created attachment 42327 [details] [review]
Bug 14458: 5. Add SwaggerUI documentation for RESTful API

Changed API endpoint to /api/v1/...

Comment 10 Julian Maurice 2018-01-18 15:12:30 UTC

Closing this as I doubt it is wanted in Koha.
But feel free to reopen if you think otherwise.