掲示板 Forums - Interested in working with a renshuu API?

1. I'll try to get those weird indexes out of config. Values:

unique-furigana - the reading cannot be perfectly matched to the kanji (like 今日/きょう)

katakana- has katakana in it

common-hiragana - usually written without kanji

ent_primary - jmdict reference. this is the main kanji/hiragana pair for a set of related terms. Example: 作る (it is the primary form, although there are two alternates)

ent_single - jmdict reference. this entry does not have any alternate forms

'ateji','rK','io','ik','iK','oK','sk','sK' <-- all jmdict tags. See https://www.edrdg.org/jmdict/j...

2. 入賞 issue is fixed.

3. The response codes should not be trusted yet. There is no way you can access other data, so don't worry about that. It's just that the codes haven't been implemented.

4. total_page fixed. Although...I guess I need to align the pg as well - it's currently counting from 0, whereas the total is counting from 1. Start pg from 1?

5. if requested page goes over, it now shows "pg" as the correct page (well, issue from #4 aside)

6. Sure, I can add alt-form ids (later)

7. It's attached to the hidden input with id="api_key" inside of the settings panel. Will consider moving it "outside" later on.

1. Fixed page numbers (starts on 1)

2. Also added ids to alternate forms.

3. I started working on an openapi json file, I guess I need a system that will output nice html from that for reference - I searched a bit, but didn't see anything that was a once-and-done (I don't think I'll be updating it so much that I need a complex system, just a onetime /json2html.sh input.json outputdir

kind of thing.

As to the schedules thing, I'll get the error codes up as soon as I can figure out what to add. This is a tricky one - so let's say they do a put/delete on the word 日本, and the schedule/list part doesn't work. Should I return *nothing*, and an error code, or return the word object like I usually do, then an error field that explains what happened? If that was the case, would the http response code still be normal (200)?

https://github.com/buruburukun/renshuu_helper updated to handle new page numbers and alternate forms! Please try it out!

As for return codes, I believe you can return 4xx and while also returning a response which could have the explanation of the error, but I could be wrong about that. As an aside, I thought it was a bit weird that the PUT/DELETE endpoints returned the word at all. It makes the endpoint feel like it's doing more than it should. I think your intent there is so the client can know the latest presence information?

And an additional bug report: searching for あちら with the api returns a strange definition 2 with a triple "&": "that (one) (something physically distant from both speaker and listener＆＆＆ or something not visible but known by both speaker and listener)"

So, I tried putting together the json for the openapi spec

https://new.renshuu.org/api.js...

And then put it in here: https://editor-next.swagger.io... (easy to do, no login required)

Not sure why, but you cannot load that url into swagger - you need to copy/paste the text. Also, something is wrong with the http bearer docs in the json, making it so swagger cannot do test calls.

That being said, please take a look and see what you think. If it looks good, I'll expand it out for the put/delete, as well as add the object definitions for the lists/schedules returned under presence.

Yea - you have to access the api.json (I actually made an api.yaml that is a bit more accurate) outside of renshuu, as in, copy-paste the link.

It looks like the cors issue is only for the specific way that page is trying to access it. I made a free swagger.io acct, and that one runs just fine.

I'm not sure I want to run another web server just for this on my current nginx box, so I may spin up a mini server and throw both the endpoints and the docs on there.

So ignore the "try it out", and see if the rest of the docs there look decent.

The cors stuff is relevant when JavaScript running on one domain tries to request stuff that is provided by a different one.

why would you need a second Webserver? I don't know about nginx but can't you serve the API from the normal server?

Tiny nitpick I just noticed when trying the swagger page. The api server seems to respond with

 content-type: text/html; charset=UTF-8 

instead of saying that the response is application/json.

both header issues fixed

/schedule fleshed out, should be data complete (updated on docs, too)

/kanji and /grammar are both live, in docs too.

Will probably get /sentence done tomorrow!

Is there some kind of standard for reporting api remaining limits? a few fields attached to every call (you've used xx today. You have yy remaining).

/profile is UP, and on the docs page.

Please let me know what else you'd like to see added. This will be self-lookup only, so pretty much the sky's the limit.